[ODATA-1099] Add annotations to describe custom query options and custom headers - OASIS Technical Committees Issue Tracker

XML

Word

Printable

Proposal:

Hide

See https://github.com/oasis-tcs/odata-vocabularies/blob/ODATA-1099/vocabularies/Org.OData.Capabilities.V1.md#CustomHeaders

2018-1-0: Proposal amended by unanimous consent to restrict the "AppliesTo" to "EntityContainer". This allows us to specify global (service-wide) query options or headers. Resource-specific header and query option requirements can be applied through the HttpRequests annotation term defined in ~~ODATA-884~~. Update the applied change to restrict to "EntityContainer" and update description to specify that they are applied to service.

2019-2-14: Ammend proposal to change "RetrieveRestrictions" to "ReadRestrictions"

Show
See https://github.com/oasis-tcs/odata-vocabularies/blob/ODATA-1099/vocabularies/Org.OData.Capabilities.V1.md#CustomHeaders 2018-1-0: Proposal amended by unanimous consent to restrict the "AppliesTo" to "EntityContainer". This allows us to specify global (service-wide) query options or headers. Resource-specific header and query option requirements can be applied through the HttpRequests annotation term defined in ODATA-884 . Update the applied change to restrict to "EntityContainer" and update description to specify that they are applied to service. 2019-2-14: Ammend proposal to change "RetrieveRestrictions" to "ReadRestrictions"
Resolution:

Hide

https://github.com/oasis-tcs/odata-vocabularies/pull/6

Show
https://github.com/oasis-tcs/odata-vocabularies/pull/6

Some services support custom query options, either across the board, or for specific resources or resource types.

Other services support or even require custom headers, e.g. for CSRF protection.

We need a way to express in metadata which custom query options and custom headers are available / required where.

Progress

Closed

Unassigned