Allow 'links.self' as objects in the schema #1160
Merged
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 spec says that a link can be either a string or an object: http://jsonapi.org/format/#document-links However the schema enforces that `self` links must be strings: https://github.com/json-api/json-api/blob/509ee949c621cee5683c959d4268386e1a592b83/schema#L158-L162 It is also a bit odd that the properties and descriptions in `definitions/links` seems to be relationship-specific: https://github.com/json-api/json-api/blob/509ee949c621cee5683c959d4268386e1a592b83/schema#L154-L168 , but this definition is referenced from resource: https://github.com/json-api/json-api/blob/509ee949c621cee5683c959d4268386e1a592b83/schema#L144-L146 and top level: https://github.com/json-api/json-api/blob/509ee949c621cee5683c959d4268386e1a592b83/schema#L38-L43 link objects. @steveklabnik has confirmed in GH issue json-api#1159 that the spec is the source of truth and the schema might lag behind. This change allows the self link to be an object as well as a string. It also makes sure that each property in the `links` object is a `definitions/link` (as per spec). It also separates a relationshipLinks definition that seems to carry some relationship-specific descriptions. Fixes json-api#1159
|
Thank you! @dgeb what do you think? |
jamesplease
approved these changes
May 9, 2017
|
@tadast thanks much! Apologies for taking so long to review. |
elliotttf
added a commit
to elliotttf/jsonapi-validator
that referenced
this pull request
Aug 8, 2017
elliotttf
added a commit
to elliotttf/jsonapi-validator
that referenced
this pull request
Aug 8, 2017
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.
See #1159 for context.
This change allows the self link to be an object as well as a string as per spec.
It also makes sure that each property in the
linksobject is adefinitions/link, as per spec.It also separates a
relationshipLinksdefinition that seems to carrysome relationship-specific descriptions. Although it could easily use the modified
linksdefinition as well with the same effect. If we don't care about these descriptions I can modify this PR for the relationship.links to use the newlinksdefinition.Fixes #1159