Uploaded image for project: 'OASIS Open Data Protocol (OData) TC'
  1. OASIS Open Data Protocol (OData) TC
  2. ODATA-1334

Mismatch in ModificationException term naming

    XMLWordPrintable

    Details

    • Type: Bug
    • Status: Closed
    • Priority: Major
    • Resolution: Fixed
    • Affects Version/s: V4.01_CSD03
    • Fix Version/s: V4.01_CS02
    • Component/s: Protocol, Vocabularies
    • Labels:
      None
    • Environment:

      [Proposed]

    • Proposal:
      Hide

      a. Update the protocol document to refer to "Core.ModificationException", or
      b. Update the Core.Vocabulary to prefix "Data" to "ModificationException", "ModificationExceptionType", and "ModificationOperationKind"

      I kinda prefer the prefixed name (b), although it is slightly longer. However, the vocabulary changes are "live" where-as the protocol document has not yet been finalized, so b) would technically be a breaking change to anyone using the new vocabulary term, although it could be argued that it's unlikely that people are already using that term.

      Show
      a. Update the protocol document to refer to "Core.ModificationException", or b. Update the Core.Vocabulary to prefix "Data" to "ModificationException", "ModificationExceptionType", and "ModificationOperationKind" I kinda prefer the prefixed name (b), although it is slightly longer. However, the vocabulary changes are "live" where-as the protocol document has not yet been finalized, so b) would technically be a breaking change to anyone using the new vocabulary term, although it could be argued that it's unlikely that people are already using that term.
    • Resolution:
      Show
      https://github.com/oasis-tcs/odata-vocabularies/pull/60/files  

      Description

      In our last F2F we added a new term for annotating failed data modifications within a bulk (i.e., delta) payload. We went back and forth on the naming, and ended up with different names between the vocabulary and the protocol document.

      The protocol document, in section 11.4.12, Update a Collection of Entities, refers to the "Core.DataModificationException". However, the Core vocabulary defines "ModificationException" along with "ModificationExceptionType" and "ModificationOperationKind".

        Attachments

          Activity

            People

            • Assignee:
              Unassigned
              Reporter:
              mikep Michael Pizzo
            • Watchers:
              1 Start watching this issue

              Dates

              • Created:
                Updated:
                Resolved: