top-level links object is related to the document in some cases #1753
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
The top-level `links` object is related to the whole document in 2 out of 4 cases: `self` and `describedby` links are related to the document. Not only to its primary data. Even more they are useful even if a document does not have primary data. A document could not have primary data if 1) being an error response, 2) a response to a successful mutation, and 3) having an extension applied. Top-level links, especially `self`, are commonly used in those cases. And intended to be used. This PR improves the wording of the specification to avoid confusion. It was motivated by this thread in the discussion forum: https://jsonapi.org/format/
|
Looks like a solid correction. Thanks! |
|
Is this something that would be back-ported v1.1? Being more of a clarifying change than an actual change to the spec, seems appropriate. 🤷♂️ |
jelhan
added a commit
that referenced
this pull request
Aug 22, 2024
The clarification was merged to v1.2 (upcoming) in #1753. This backports the changes to v1.1.
Thanks for the reminder. I created #1754 to do so. |
dgeb
pushed a commit
that referenced
this pull request
Sep 17, 2024
The clarification was merged to v1.2 (upcoming) in #1753. This backports the changes to v1.1.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
The top-level
linksobject is related to the whole document in 2 out of 4 cases:selfanddescribedbylinks are related to the document. Not only to its primary data. Even more they are useful even if a document does not have primary data.A document could not have primary data if 1) being an error response, 2) a response to a successful mutation, and 3) having an extension applied. Top-level links, especially
self, are commonly used in those cases. And intended to be used.This PR improves the wording of the specification to avoid confusion. It was motivated by this thread in the discussion forum: https://jsonapi.org/format/
TODO: