[ODATA-126] Metadata as an OData service - OASIS Technical Committees Issue Tracker

Details

Type: New Feature
Status: Closed
Priority: Major
Resolution: Fixed
Affects Version/s: V4.0_WD01
Fix Version/s: V4.0_WD01
Component/s: CSDL XML, Protocol, URL Conventions
Labels:
None
Environment:

[Applied]

Proposal:

Hide

Define CSDL schema for CSDL and allow application/atomsvc+xml and application/json as additional representations of ~/$metadata/, returning an Atom or JSON service document for accessing the metadata of the service.

~/$metadata/$metadata will return the constant schema for CSDL, and we should end the recursion there.

Chapter 15 of https://www.oasis-open.org/committees/download.php/49309/odata-v4.0-wd02-part3-csdl-2013-05-22.docx

CSDL: https://tools.oasis-open.org/version-control/browse/wsvn/odata/trunk/spec/schemas/MetadataService.edmx

Diagram: https://tools.oasis-open.org/version-control/browse/wsvn/odata/trunk/spec/examples/MetadataService/EntityDesignerDiagram.png?op=dl&rev=0&isdir=0

Accepted: https://www.oasis-open.org/committees/download.php/49325/odata-meeting-38_on-20130523-minutes.html#odata-126

Show
Define CSDL schema for CSDL and allow application/atomsvc+xml and application/json as additional representations of ~/$metadata/, returning an Atom or JSON service document for accessing the metadata of the service. ~/$metadata/$metadata will return the constant schema for CSDL, and we should end the recursion there. Chapter 15 of https://www.oasis-open.org/committees/download.php/49309/odata-v4.0-wd02-part3-csdl-2013-05-22.docx CSDL: https://tools.oasis-open.org/version-control/browse/wsvn/odata/trunk/spec/schemas/MetadataService.edmx Diagram: https://tools.oasis-open.org/version-control/browse/wsvn/odata/trunk/spec/examples/MetadataService/EntityDesignerDiagram.png?op=dl&rev=0&isdir=0 Accepted: https://www.oasis-open.org/committees/download.php/49325/odata-meeting-38_on-20130523-minutes.html#odata-126
Resolution:

Hide

https://www.oasis-open.org/committees/download.php/49309/odata-v4.0-wd02-part3-csdl-2013-05-22.docx
https://tools.oasis-open.org/version-control/browse/wsvn/odata/trunk/spec/schemas/MetadataService.edmx

Accepted: https://www.oasis-open.org/committees/download.php/49557/odata-meeting-41_on-20130613_14-F2F-minutes.html#odata-126

Show
https://www.oasis-open.org/committees/download.php/49309/odata-v4.0-wd02-part3-csdl-2013-05-22.docx https://tools.oasis-open.org/version-control/browse/wsvn/odata/trunk/spec/schemas/MetadataService.edmx Accepted: https://www.oasis-open.org/committees/download.php/49557/odata-meeting-41_on-20130613_14-F2F-minutes.html#odata-126

Description

Instead of a monolithic XML metadata document the metadata could be made available as an OData service with a fixed schema:

Entity types

EntitySet
EntityType
Property
Annotation
...

Entity sets

EntitySets
EntityTypes
Properties
Annotations
...

This meta-service could be accessed via a canonical URL, ideally ~/$metadata/ with $format=atom/json or a corresponding Accept header.

This would allow accessing only parts of the metadata document the client is interested in and simplify parsing for clients: they only need to know how to interpret "normal" OData feed and entity response payloads without needing a separate metadata format.

It would also conveniently provide a JSON format for metadata.

Accepted: https://www.oasis-open.org/committees/download.php/48097/odata-meeting-23_on-20130130_31-F2F-minutes.html#odata-126

OASIS Open Data Protocol (OData) TC

Metadata as an OData service

Details

Description

Attachments

Activity

People

Dates