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

Clarify that a server MUST respond with content-id annotations and MUST include nested entity IDs

    XMLWordPrintable

    Details

    • Proposal:
      Hide

      New wording for 11.4.2.2: 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 201 Created SHOULD annotate the entities in the response using the same Core.ContentID value as specified in the request. Services SHOULD advertise support for deep inserts through the Capabilities.DeepInsertSupport term, defined in [OData-VocCap]; services that advertise support through Capabilities.DeepInsertSupport MUST return the Core.ContentID for the inserted or updated entities.
       
      Clarify that the response must include the entity ID (or all key properties if conventional IDs are used) for all entities returned in the response for a create or update.

      Show
      New wording for 11.4.2.2: 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 201 Created SHOULD annotate the entities in the response using the same Core.ContentID value as specified in the request. Services SHOULD advertise support for deep inserts through the Capabilities.DeepInsertSupport term, defined in [OData-VocCap] ; services that advertise support through Capabilities.DeepInsertSupport MUST return the Core.ContentID for the inserted or updated entities.   Clarify that the response must include the entity ID (or all key properties if conventional IDs are used) for all entities returned in the response for a create or update.
    • Resolution:
      Show
      https://www.oasis-open.org/committees/download.php/64647/odata-v4.01-wd06-part1-protocol-2019-02-01.docx

      Description

      Currently in section 11.4.2.2 in the part 1 protocol document it says that the server SHOULD annotate entities in the response with the same content-id used in the request.  This SHOULD needs to be a MUST if the server supports content-ids in deep insert/deep update requests.

       

      We also need to clarify that the response must include the entity ID for all entities returned in the response for a create or update if conventional entity IDs are not used.

        Attachments

          Activity

            People

            • Assignee:
              Unassigned
              Reporter:
              matt.borges Matthew Borges
            • Watchers:
              2 Start watching this issue

              Dates

              • Created:
                Updated:
                Resolved: