[ODATA-956] Do we need to add SchemaVersion to ContextURL? - OASIS Technical Committees Issue Tracker

XML

Word

Printable

Details

Type: Bug
Status: Closed
Priority: Major
Resolution: Fixed
Affects Version/s: V4.01_WD01
Fix Version/s: V4.01_WD01
Component/s: Protocol
Labels:
None
Environment:

[Proposed]

Proposal:

Hide

A service MAY return the schemaVersion annotation as an instance annotation to specify the version of the schema the response was generated from. For streamed JSON this annotation, if present, MUST immediately follow the context property.

schemaVersion MAY be included in embedded contextURLs or in odata.type annotations with full URLs.

If a service returns a payload whose schema is not compatible with the "unversioned" schema, it MUST include the schemaVersion instance annotations, as appropriate, in the payload.

ALSO, support the schemaVersion annotation as a child of the <References> element.

Show
A service MAY return the schemaVersion annotation as an instance annotation to specify the version of the schema the response was generated from. For streamed JSON this annotation, if present, MUST immediately follow the context property. schemaVersion MAY be included in embedded contextURLs or in odata.type annotations with full URLs. If a service returns a payload whose schema is not compatible with the "unversioned" schema, it MUST include the schemaVersion instance annotations, as appropriate, in the payload. ALSO, support the schemaVersion annotation as a child of the <References> element.
Resolution:

Hide

https://www.oasis-open.org/apps/org/workgroup/odata/download.php/59028/odata-v4.01-wd01-part1-protocol.docx
https://www.oasis-open.org/apps/org/workgroup/odata/download.php/59031/odata-csdl-xml-v4.01-wd01.docx
https://www.oasis-open.org/apps/org/workgroup/odata/download.php/59030/odata-json-format-v4.01-wd01.docx
https://tools.oasis-open.org/version-control/browse/wsvn/odata/trunk/4.01%20spec/vocabularies/Org.OData.Core.V1.xml

Show
https://www.oasis-open.org/apps/org/workgroup/odata/download.php/59028/odata-v4.01-wd01-part1-protocol.docx https://www.oasis-open.org/apps/org/workgroup/odata/download.php/59031/odata-csdl-xml-v4.01-wd01.docx https://www.oasis-open.org/apps/org/workgroup/odata/download.php/59030/odata-json-format-v4.01-wd01.docx https://tools.oasis-open.org/version-control/browse/wsvn/odata/trunk/4.01%20spec/vocabularies/Org.OData.Core.V1.xml

Description

In ~~ODATA-928~~ we added the ability for a service to make breaking changes to metadata, and for a client to request a specific version of the metadata using the new SchemaVersion header.

Do we need a way to encode the schemaversion as part of the contextUrl, or must the client processing the response know the schemaversion to use when requesting the metadata (including for nested contextUrls)?

Perhaps using the SchemaVersion annotation as an instance annotation on the result payload?

Attachments

Activity

People

Assignee:

Unassigned

Reporter:

Michael Pizzo

Watchers:

1 Start watching this issue

Dates

Created:

06/Jul/16 1:02 AM

Updated:

29/Sep/16 7:58 PM

Resolved:

11/Aug/16 3:58 PM