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

Clarify use of @Core.ContentId in delta update

    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
    • Labels:
      None
    • Environment:

      Proposed

    • Proposal:
      Hide

      Add the same text to "Update a Collection", where we describe delta updates, as we currently have in sections describing deep insert and deep update.

      Note that the DeepInsert and DeepUpdate capabilities that describe support for ContentId should be relevant within a delta update request.

      Proposed wording:
      Clients MAY associate an id with individual nested entities in the request by using the Core.ContentID term defined in [OData-VocCore]. Services that respond with 200 OK SHOULD annotate the entities in the response using the same Core.ContentID value as specified in the request.

      Services SHOULD advertise support for updating a collection using a delta payload using the DeltaUpdateSupported property of the Capabilities.UpdateRestrictions vocabulary term, and SHOULD advertise support for returning the Core.ContentID in the response to a delta update through the Capabilities.DeepUpdateSupport term, both defined in [OData-VocCap].

      Show
      Add the same text to "Update a Collection", where we describe delta updates, as we currently have in sections describing deep insert and deep update. Note that the DeepInsert and DeepUpdate capabilities that describe support for ContentId should be relevant within a delta update request. Proposed wording: Clients MAY associate an id with individual nested entities in the request by using the Core.ContentID term defined in [OData-VocCore] . Services that respond with 200 OK SHOULD annotate the entities in the response using the same Core.ContentID value as specified in the request. Services SHOULD advertise support for updating a collection using a delta payload using the DeltaUpdateSupported property of the Capabilities.UpdateRestrictions vocabulary term, and SHOULD advertise support for returning the Core.ContentID in the response to a delta update through the Capabilities.DeepUpdateSupport term, both defined in [OData-VocCap] .
    • Resolution:
      Show
      https://www.oasis-open.org/committees/download.php/66154/odata-v4.01-wd08-part1-protocol-2019-10-31.docx

      Description

      We added the @Core.ContentId annotation in order to enable annotating instances in an insert request to be correlated with results in the returned response. We specifically call out its use in deep insert and deep update requests in [Protocol], but omit mentioning it in bulk (delta) update requests.

      It's use in these cases is implied through deep insert and deep update, and from the description of the annotation, but we should add the same text to the delta update section.

        Attachments

          Activity

            People

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

              Dates

              • Created:
                Updated:
                Resolved: