-
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:
-
Resolution:
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.
| Field | Original Value | New Value |
|---|---|---|
| Proposal |
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. |
|
| Assignee | Ralf Handl [ ralfhandl ] | |
| Environment | [Proposed] |
| Environment | [Proposed] |
| Proposal |
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. |
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. Draft of ER model for metadata service: https://tools.oasis-open.org/version-control/browse/wsvn/odata/trunk/spec/examples/MetadataService/EntityDesignerDiagram.png?op=dl&rev=0&isdir=0 |
| Description |
Instead of o monolithic XML metadata document the metadata could be made available as an OData service with a fixed schema: Entity types - EntitySet - EntityType - Property - ValueAnnotation - ... Entity sets - EntitySets - EntityTypes - Properties - VallueAnnotations - ... 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. |
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 - ValueAnnotation - ... Entity sets - EntitySets - EntityTypes - Properties - VallueAnnotations - ... 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. |
| Status | New [ 10000 ] | Open [ 1 ] |
| 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 - ValueAnnotation - ... Entity sets - EntitySets - EntityTypes - Properties - VallueAnnotations - ... 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. |
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 - ValueAnnotation - ... Entity sets - EntitySets - EntityTypes - Properties - VallueAnnotations - ... 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 |
| Environment | [Proposed] |
| Proposal |
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. Draft of ER model for metadata service: https://tools.oasis-open.org/version-control/browse/wsvn/odata/trunk/spec/examples/MetadataService/EntityDesignerDiagram.png?op=dl&rev=0&isdir=0 |
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. 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 |
| Proposal |
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. 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 |
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 |
| 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 - ValueAnnotation - ... Entity sets - EntitySets - EntityTypes - Properties - VallueAnnotations - ... 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 |
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 |
| Resolution | Fixed [ 1 ] | |
| Status | Open [ 1 ] | Resolved [ 5 ] |
| Environment | [Proposed] | [Applied] |
| Status | Resolved [ 5 ] | Applied [ 10002 ] |
| Status | Applied [ 10002 ] | Closed [ 6 ] |
| Reporter | Ralf Handl [ ralfhandl ] | Ralf Handl [ handl ] |
| Assignee | Ralf Handl [ ralfhandl ] | Ralf Handl [ handl ] |