[OASIS Issue Tracker] (ODATA-923) Support subsetting returned metadata

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

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

Michael Pizzo updated ODATA-923:
--------------------------------

    Proposal: 
Add a new preference, metadata-scope, that can be specified on a metadata request. The value follows the syntax for the fragment portion of a context URL to describe the shape of results for which the client needs metadata.

Clients can then extract the fragment portion of the context url to use in the preference to requests only the metadata required to describe that particular response.  If the response spans multiple namespaces the service MAY include multiple schema elements in the response, one per namespace containing types used in the response.  Since this is a preference, services can also ignore and just return the metadata with references to related metadata.

Services that support the metadata-scope preference SHOULD include a preference-applied header specifying the contextUrl fragment identifying the results described by the returned metadata.

Example: to include the metadata required to describe customers and their orders, the client could specify:

http://sampleservice.com/$metadata
Prefer: metadata-scope=Customers(Orders)

Services can return preference-applied to specify the extent of the metadata included. For any included namespaces, the service must return at least the requested data, but data in related namespaces can be referenced through Include.

  was:
Add a new preference, metadata-scope, that can be specified on a metadata request. The value follows the syntax for the fragment portion of a context URL to describe the shape of results for which the client needs metadata.

Clients can then extract the fragment portion of the context url to use in the preference to requests only the metadata required to describe that particular response.  If the response spans multiple namespaces the service MAY include multiple schema elements in the response, one per namespace containing types used in the response.  Since this is a preference, services can also ignore and just return the metadata with references to related metadata.

Services that support the metadata-scope preference SHOULD include a preference-applied header specifying the contextUrl fragment identifying the results described by the returned metadata.

Example: to include the metadata required to describe customers and their orders, the client could specify:

http://sampleservice.com/$metadata
Prefer: metadata-scope=Customers(Orders)


> Support subsetting returned metadata
> ------------------------------------
>
>                 Key: ODATA-923
>                 URL: https://issues.oasis-open.org/browse/ODATA-923
>             Project: OASIS Open Data Protocol (OData) TC
>          Issue Type: Improvement
>          Components: CSDL XML
>    Affects Versions: V4.0_ERRATA03
>            Reporter: Ralf Handl
>            Assignee: Michael Pizzo
>             Fix For: V4.01_CSD02
>
>
> After being able to partition large services into smaller ones using cross-service navigation we might want to support requesting multiple of these small files in one request, similar to expanding an entity and including related entities.



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