-
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 |
The current model (picture and edmx) are checked into SVN:
- https://tools.oasis-open.org/version-control/browse/wsvn/odata/trunk/spec/examples/MetadataService/MetaModel.edmx?sc=1 (V3 format
- https://tools.oasis-open.org/version-control/browse/wsvn/odata/trunk/spec/examples/MetadataService/EntityDesignerDiagram.png?op=dl&rev=0&isdir=0
ToDo:
- Convert Edmx to V4 format (could someone write an XSL translation for that?)
- Transform entity types AnnotationsElement and ParameterType into complex types and targeting navigation properties into complex properties
- Add Documentation complex property type to all approprioate entity types
Feedback is highly welcome!
| Environment | [Proposed] |
Is there a mapping to base a transform for the MetaModel.edmx transition from v3 to v4 upon?
I'ld be willing to act on the first item in the above todo lit (inside Ralf's comment.
The transformation steps needed are:
- Keep edmx:Edmx wrapper element, change xmlns:edmx to new edmx and make Version=4.0"
- Translate edmx:Edmx/edmx:Runtime/edmx:ConceptualModels into edmx:DataServices
- Keep Schema element, change xmlns to new edm, remove all other xmlns:xxx attributes
- Keep EntityType, ComplexType, EnumType, EntityContainer, remove Association (and maybe more)
- Keep NavigationProperty, use Relationship and ToRole to extract Type from corresponding Association/End, using Multiplicity="*" for Collection(...)
Here are two files, one V3 produced with Visual Studio, one V4 transformed manually, to be used for testing an automatic transformation:
- https://tools.oasis-open.org/version-control/browse/wsvn/odata/trunk/spec/examples/MetadataService/TestV3.edmx
- https://tools.oasis-open.org/version-control/browse/wsvn/odata/trunk/spec/examples/MetadataService/TestV4.edmx
And here's a first shot at the transformation: https://tools.oasis-open.org/version-control/browse/wsvn/odata/trunk/spec/examples/MetadataService/V3-to-V4-CSDL.xsl
Removed typos
- EntityType and ComplexType inherit from Type, so no Key, Fullname and Name
- Navigation property Schema consistently had wrong type: EntityContainer -> Schema
- NamedEntities not directly related to Schema, only to EntityContainer
- ParameterType was used via NavigationProperty, but is complex type -> Property
- Include/Uri -> Include/Namespace
- Introduced complex type KeyProperty to reflect our new Alias attribute for key properties
- Cleaned up Nullable facet: optionality in XML-CSDL no longer reflected, instead MetadataService will show default 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. 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 ] |
Reference to meeting #41 minute link fragment documenting the approval of application has been added.
| Status | Applied [ 10002 ] | Closed [ 6 ] |
| Reporter | Ralf Handl [ ralfhandl ] | Ralf Handl [ handl ] |
| Assignee | Ralf Handl [ ralfhandl ] | Ralf Handl [ handl ] |
There have been a lot of requests for this in the past, but we need a full proposal (including CSDL of the metadata document) to understand design details and provide sufficient direction to the editors. This might be good to add to the issues to work on at the November Face to Face.