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

Ambiguity with Capabilities.ChangeTracking annotation

    XMLWordPrintable

    Details

    • Proposal:
      Hide

      Remove EntityContainer from the AppliesTo list. Part 1: Protocol only mentions this term for annotating entity sets.

      Add a LongDescription to FilterableProperties and ExpandableProperties:

      If no properties are specified or Filterable/ExpandableProperties is omitted, clients cannot assume support for filtering on/expanding any properties.

      Show
      Remove EntityContainer from the AppliesTo list. Part 1: Protocol only mentions this term for annotating entity sets. Add a LongDescription to FilterableProperties and ExpandableProperties: If no properties are specified or Filterable/ExpandableProperties is omitted, clients cannot assume support for filtering on/expanding any properties.
    • Resolution:
      Show
      https://github.com/oasis-tcs/odata-vocabularies/pull/38/files

      Description

      Suppose I have an entity type with 2 structural properties (A, B) and 2 navigation properties (C, D).

       

      Then I use :

       

      <Annotation Term=”Capabilities.ChangeTracking”>

        <Record>

          <PropertyValue Property=”FilterableProperties”/>

            <Collection>

              <PropertyPath>A</PropertyPath>

            </Collection>

          </Record>

      </Annotation>

       

      Now it is clear that A is filterable and B is not. But how is the client to interpret ExpandableProperties not being specified (defaults to an empty Collection(NavigationPropertyPath))?

       

      1. The server omitted these properties from the annotation because they (C, D) are all expandable.
      2. The server omitted these properties from the annotation because they (C, D) are not expandable.

       

      The interpretation of an empty collection here is ambiguous.

        Attachments

          Activity

            People

            • Assignee:
              Unassigned
              Reporter:
              evan.ireland.2 Evan Ireland
            • Watchers:
              2 Start watching this issue

              Dates

              • Created:
                Updated:
                Resolved: