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

Allow PATCH to entity sets using the delta-response format

    XMLWordPrintable

    Details

    • Type: Improvement
    • Status: Closed
    • Priority: Major
    • Resolution: Fixed
    • Affects Version/s: V4.0_OS
    • Fix Version/s: V4.01_WD01
    • Component/s: JSON Format, Protocol
    • Labels:
    • Environment:

      Set Operations, [Proposed]

    • Proposal:
      Hide

      PATCH to a collection of entities can take a delta payload (interpreted as deltas if body represents a collection of entities) ODATA-613
      a. MUST NOT have $filter, $select, $orderby, etc.

      For PATCH, you don't specify a $expand so the extent of that graph is undefined. Therefore, it is valid to have added/deleted links to anything (at least anything reachable from the target; service probably wouldn't bother validating). So Clients SHOULD make sure added/deleted links are reachable from target, but services need not validate.

      Response, if requested, should be a delta representation, in the same structure and order as the request payload, representing changes.

      Show
      PATCH to a collection of entities can take a delta payload (interpreted as deltas if body represents a collection of entities) ODATA-613 a. MUST NOT have $filter, $select, $orderby, etc. For PATCH, you don't specify a $expand so the extent of that graph is undefined. Therefore, it is valid to have added/deleted links to anything (at least anything reachable from the target; service probably wouldn't bother validating). So Clients SHOULD make sure added/deleted links are reachable from target, but services need not validate. Response, if requested, should be a delta representation, in the same structure and order as the request payload, representing changes.

      Description

      This will allow easy synchronization between services with same model

      Previous proposal (for sanity check):

      Document changes:
      part1-protocol

      Add section: 11.4.10 Update an Entity Set
      To update a collection, the client sends a PATCH request to that collection's URL. The PATCH body MUST contain a valid delta response consisting of appropriate representations for
      If the target URL for the collection is a navigation link, any added entity is automatically linked to the entity containing the navigation link, and any deleted entity is automatically unlinked.

        Attachments

          Activity

            People

            • Assignee:
              mikep Michael Pizzo (Inactive)
              Reporter:
              handl Ralf Handl
            • Watchers:
              1 Start watching this issue

              Dates

              • Created:
                Updated:
                Resolved: