[OASIS Issue Tracker] (ODATA-796) Add annotation to specify whether additional properties may be returned for an entity

[OASIS Issues Tracker <workgroup_mailer@lists.oasis-open.org>]

     [ https://issues.oasis-open.org/browse/ODATA-796?page=com.atlassian.jira.plugin.system.issuetabpanels:all-tabpanel ]

Michael Pizzo updated ODATA-796:
--------------------------------

    Proposal: 
Add a new Boolean annotation, applied to an entity, that specifies whether the service is allowed to return additional properties not specified in $metadata.

Property could be "AdditionalProperties" (to match JSON Schema) and have no default value (require specify bool=false) or could be named something like "OnlyDeclaredProperties" and be a tagging annotation with a default of true when applied.

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

  was:Add a new "AdditionalProperties", applied to an entity, that specifies whether the service is allowed to return additional properties not specified in $metadata.


> Add annotation to specify whether additional properties may be returned for an entity
> -------------------------------------------------------------------------------------
>
>                 Key: ODATA-796
>                 URL: https://issues.oasis-open.org/browse/ODATA-796
>             Project: OASIS Open Data Protocol (OData) TC
>          Issue Type: Bug
>          Components: OData CSDL
>    Affects Versions: V4.0_ERRATA02
>         Environment: [Proposed]
>            Reporter: Michael Pizzo
>             Fix For: V4.0_ERRATA03
>
>
> 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.



--
This message was sent by Atlassian JIRA
(v6.2.2#6258)