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

Clarify what requests can be delta enabled

    XMLWordPrintable

    Details

    • Type: Improvement
    • Status: Closed
    • Priority: Minor
    • Resolution: Fixed
    • Affects Version/s: None
    • Fix Version/s: V4.01_CSD02
    • Component/s: Protocol
    • Labels:
      None
    • Environment:

      Applied

    • Proposal:
      Hide
      • Clarify that any GET request to retrieve one or more entities MAY be delta enabled by the service. A service MAY support delta enabling additional GET requests.
      • Add Singleton, Navigation Property, and Funtion to the AppliesTo of the ChangingTracking term.

      Reasoning:

      • The entity set scenario is already well documented so nothing new there.
      • The reason for the single entity case is mainly for singletons. If a service has a singleton, a natural defining query would be for the singleton entity possibly with expands. You could make the same argument for just single entities that are not singletons. The main reason I see for allowing a single entity (singleton or otherwise) without any nested entities to be delta enabled is in the case where the entity is very large (i.e. lots of large properties). In that case, the delta protocol could be used to return only the properties that have changed.
      • A function can return a collection of entities so it should be able to return a delta link.

      Add Singleton, NavigationProperty, and Function to AppliesTo of ChangeTracking term.

      Show
      Clarify that any GET request to retrieve one or more entities MAY be delta enabled by the service. A service MAY support delta enabling additional GET requests. Add Singleton, Navigation Property, and Funtion to the AppliesTo of the ChangingTracking term. Reasoning: The entity set scenario is already well documented so nothing new there. The reason for the single entity case is mainly for singletons. If a service has a singleton, a natural defining query would be for the singleton entity possibly with expands. You could make the same argument for just single entities that are not singletons. The main reason I see for allowing a single entity (singleton or otherwise) without any nested entities to be delta enabled is in the case where the entity is very large (i.e. lots of large properties). In that case, the delta protocol could be used to return only the properties that have changed. A function can return a collection of entities so it should be able to return a delta link. Add Singleton, NavigationProperty, and Function to AppliesTo of ChangeTracking term.
    • Resolution:
      Show
      https://www.oasis-open.org/committees/download.php/60366/odata-v4.01-wd02-part1-protocol-2017-03-24.docx

      Description

      The spec explicitly mentions returning delta links only in the context of retrieve entity set requests. It doesn't explicitly state whether or not other types of requests can be delta enabled. For example, can a function that returns a collection be delta enabled? Can a request for a singleton with all related entities expanded be delta enabled (for this case it isn't clear the spec would actually allow a delta link to be returned)?

      We should clarify what requests can be delta enabled.

        Attachments

          Activity

            People

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

              Dates

              • Created:
                Updated:
                Resolved: