[Date Prev] | [Thread Prev] | [Thread Next] | [Date Next] -- [Date Index] | [Thread Index] | [List Home]
Subject: [OASIS Issue Tracker] Updated: (ODATA-34) Control verbosity of $metadata response: include annotations or documentation
[ http://tools.oasis-open.org/issues/browse/ODATA-34?page=com.atlassian.jira.plugin.system.issuetabpanels:all-tabpanel ]
Michael Pizzo updated ODATA-34:
-------------------------------
Proposal:
Define new content type modifiers for $metadata requests that hints whether or not to include annotations/vocabularies:
Accept: application/xml;odata=minimal | full
-minimal means no documentation or annotations
-full means all documentation and annotations
-default (application/xml) means full
-modifier may be ignored by service
define new header to specify a subset of vocabularies to include, if applied, in $metadata or as instance annotations in result (overrides specification of odata=minimal or odata=full). Hint to service; service can ignore.
odata-IncludeVocabularies="*", "", comma-separated list of vocabulary names to include
Note that, for new proposed json format, inclusion of control information (types, links, etc.) in results is specified through application/json;odata=minimalmetadata | fullmetadata | nometadata and not affected by the odata-IncludeVocabularies header.
> Control verbosity of $metadata response: include annotations or documentation
> -----------------------------------------------------------------------------
>
> Key: ODATA-34
> URL: http://tools.oasis-open.org/issues/browse/ODATA-34
> Project: OASIS Open Data Protocol (OData) TC
> Issue Type: New Feature
> Components: OData CSDL v1.0, OData Protocol v1.0, OData URL Conventions v1.0
> Affects Versions: WD01
> Reporter: Ralf Handl
> Fix For: WD01
>
>
> Metadata documents may contain Documentation, ValueAnnotation and TypeAnnotation elements that quite increase the size of the document.
> It is desirable for (especially mobile) clients to control the size of the response and include e.g. only annotations of vocabularies the client can understand.
> This may be done via headers (Prefer, Accept?), system query options, or by exposing $metadata as an OData service itself:
> GET ~/$metadata/EntityTypes('Model.Person')?$expand=Annotations
> Ideally combined with filtering on expanded entities, see ODATA-32.
--
This message is automatically generated by JIRA.
-
If you think it was sent incorrectly contact one of the administrators: http://tools.oasis-open.org/issues/secure/Administrators.jspa
-
For more information on JIRA, see: http://www.atlassian.com/software/jira
[Date Prev] | [Thread Prev] | [Thread Next] | [Date Next] -- [Date Index] | [Thread Index] | [List Home]