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

Are additional values needed for the reason property of a removed Annotation

    Details

    • Type: Bug
    • Status: Closed
    • Priority: Major
    • Resolution: Won't Fix
    • Affects Version/s: V4.01_WD01
    • Fix Version/s: V4.01_CSD02
    • Component/s: JSON Format
    • Labels:
      None
    • Environment:

      Proposed

    • Proposal:
      Hide

      Close without fixing.

      Reasoning:

      • Additional values are unnecessary from the point of view of a client applying a delta response because the net result in both cases is the same.
      • Having a different value for the reason for a delta response and a delta upload request is an unnecessary complication that doesn’t add value and prevents easily passing the a delta response as a delta upload request.
      • "change" is a very generic term that we did discuss changing to something more meaningful. However, we were unable to come up with something better. Further, changing this value could break backwards compatibility between 4.0 and 4.01 so it's best to leave it as is.
      Show
      Close without fixing. Reasoning: Additional values are unnecessary from the point of view of a client applying a delta response because the net result in both cases is the same. Having a different value for the reason for a delta response and a delta upload request is an unnecessary complication that doesn’t add value and prevents easily passing the a delta response as a delta upload request. "change" is a very generic term that we did discuss changing to something more meaningful. However, we were unable to come up with something better. Further, changing this value could break backwards compatibility between 4.0 and 4.01 so it's best to leave it as is.

      Description

      In a nested Delta Payload, a removed annotation can include a reason property that indicates why the item was removed. Currently the value can be one of deleted or changed. The changed value can be used in one of two cases

      1) If a property of the item changed such that the item no longer fits the filter of the delta query
      2) The item is no longer linked to the collection being acted on

      The question came up as to whether an additional value is needed to distinguish between the two cases above. In the discussion there was concern that not all data sources would be able to distinguish between the to cases.

      Additionally when the Delta Payload is passed as the body of a PATCH request, only the second case above is valid. In the discussion the question came up about whether the meaning of reason could be different when used as a request and a response. The concern there is that it is desirable to be able to pass the Delta Payload received from one service on to a second service

        Attachments

          Activity

            People

            • Assignee:
              matt.borges Matthew Borges
              Reporter:
              mark.biamonte Mark Biamonte
            • Watchers:
              2 Start watching this issue

              Dates

              • Created:
                Updated:
                Resolved: