Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Use deep links in cross-spec references #2014

Merged
merged 7 commits into from
Nov 6, 2024
Merged

Use deep links in cross-spec references #2014

merged 7 commits into from
Nov 6, 2024

Conversation

HeikoTheissen
Copy link
Contributor

@HeikoTheissen HeikoTheissen commented Oct 23, 2024

The [OData-Protocol] spec references the two [OData-CSDL] specs (JSON and XML format) as two entries with separate hyperlinks. This is useful for text like

The [OData-CSDLJSON](#ODataCSDL) specification defines a JSON
representation of the entity data model exposed by an OData service.
The [OData-CSDLXML](#ODataCSDLXML) specification defines an XML
representation of the entity data model exposed by an OData service.

All other specs reference the two [OData-CSDL] specs as one, see https://github.com/oasis-tcs/odata-specs/compare/HEAD..9439daa138217848097520383d302985ac47666c#diff-db5ad1be4d39d16383ddb159ad2e1168888539f3a62b9bdd79b7e72189e446bb.

ralfhandl
ralfhandl previously approved these changes Oct 23, 2024
@@ -296,7 +296,7 @@ The edit URL of a property is the edit URL of the entity with appended
segment(s) containing the path to the property.

Services are strongly encouraged to use the canonical URL for an entity
as defined in [OData-URL](#ODataURL) for both the read URL and the edit URL of an
as defined in [#OData-URL#CanonicalURL](#ODataURL) for both the read URL and the edit URL of an
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
as defined in [#OData-URL#CanonicalURL](#ODataURL) for both the read URL and the edit URL of an
as defined in [#OData-URL#CanonicalURL] for both the read URL and the edit URL of an

@ralfhandl ralfhandl added the CSD02 Next pre-release of V4.02 label Oct 23, 2024
@ralfhandl ralfhandl self-requested a review November 6, 2024 17:33
@ralfhandl ralfhandl merged commit 5096493 into main Nov 6, 2024
1 check passed
@ralfhandl ralfhandl deleted the fix/deep-links branch November 6, 2024 17:35
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
CSD02 Next pre-release of V4.02
Projects
Status: Closed
Development

Successfully merging this pull request may close these issues.

3 participants