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

Add annotation to specify whether additional properties may be returned for an entity

    XMLWordPrintable

    Details

    • Type: Bug
    • Status: Closed
    • Priority: Major
    • Resolution: Fixed
    • Affects Version/s: V4.0_ERRATA02
    • Fix Version/s: V4.0_ERRATA03
    • Component/s: Vocabularies
    • Labels:
      None
    • Environment:

      [Applied]

    • Proposal:
      Hide

      Add a new tagging annotation "OnlyDeclaredProperties" that applies to entity types and specifies that the service will not return dynamic properties not specified in $metadata.

      This only refers to properties. Services are still allowed to return instance annotations. JSON-Schema representation would include patternproperties for annotations.

      Applied: https://tools.oasis-open.org/version-control/browse/wsvn/odata/trunk/spec/vocabularies/Org.OData.Core.V1.xml?rev=673

      Show
      Add a new tagging annotation "OnlyDeclaredProperties" that applies to entity types and specifies that the service will not return dynamic properties not specified in $metadata. This only refers to properties. Services are still allowed to return instance annotations. JSON-Schema representation would include patternproperties for annotations. Applied: https://tools.oasis-open.org/version-control/browse/wsvn/odata/trunk/spec/vocabularies/Org.OData.Core.V1.xml?rev=673

      Description

      In OData V3 only opentypes were allowed to return properties not advertised in $metadata.

      In OData V4, for increased resiliency, we said that clients should be prepared to handle additional properties on any resource, and the introduction of PATCH as the preferred method for updating allows that to happen without loss.

      However, we lost the ability for a service to say that they will never return additional properties (which is probably the default case). Since clients are required to support additional properties we didn't think this was important, but as we look to a json-schema format it becomes interesting for telling clients (i.e., for validation) whether or not additional properties are allowed.

        Attachments

        There are no Sub-Tasks for this issue.

          Activity

            People

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

              Dates

              • Created:
                Updated:
                Resolved: