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

Clarify Delta responses with Minimal Metadata

    XMLWordPrintable

    Details

    • Type: Bug
    • Status: Closed
    • Priority: Major
    • Resolution: Fixed
    • Affects Version/s: V4.0_OS
    • Fix Version/s: V4.0_ERRATA01
    • Labels:
      None
    • Environment:

      [Applied]

    • Proposal:
      Hide

      Clarify that @odata.contextUrl for added/deleted links, deleted entities, and entities from sets other than specified in the context url of the feed, as well as @odata.id for added/updated entities and @odata.deltaLink for additional changes must be present in a delta response, even in minimal metadata.

      Accepted: https://www.oasis-open.org/committees/download.php/52864/odata-meeting-71_on-20140424-minutes.html#odata-638

      Show
      Clarify that @odata.contextUrl for added/deleted links, deleted entities, and entities from sets other than specified in the context url of the feed, as well as @odata.id for added/updated entities and @odata.deltaLink for additional changes must be present in a delta response, even in minimal metadata. Accepted: https://www.oasis-open.org/committees/download.php/52864/odata-meeting-71_on-20140424-minutes.html#odata-638

      Description

      Within a delta response, @odata.context is used to convey that a link has been added, or that a link or entity has been deleted, and @odata.id is used to convey id of an added or updated entry.

      In minimal metadata, we say that data that can be computed on the client can be omitted. Clearly the context url is still required for added links, deleted links, and deleted entries, as well as added/updated entities from sets other than indicated by the response context url as that cannot be computed from the payload. the id may be computed from the payload only if the payload contains the id fields, and since a service is allowed to return only changed fields then it must also include the id for added/updated entities, even in minimal metadata. same is true for @odata.deltaLink on the last page of the response for retrieving additional changes.

        Attachments

          Activity

            People

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

              Dates

              • Created:
                Updated:
                Resolved: