Schema should allow link objects as pagination links #1379
Merged
Conversation
This file contains 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
wimleers
reviewed
Mar 8, 2019
schema
Outdated
| @@ -292,28 +292,28 @@ | |||
| "first": { | |||
| "description": "The first page of data", | |||
| "oneOf": [ | |||
| { "type": "string", "format": "uri-reference" }, | |||
| { "$ref": "#/definitions/linkage" }, | |||
There was a problem hiding this comment.
s/linkage/link/
I suspect this is a typo caused by IDE autocompletion :)
|
This appears to be essentially the same problem as #1159 encountered and #1160 fixed. The spec talks about pagination links as being a set of 4 keys that MUST be used for pagination links, and it also talks about how each link MUST be either a string or a link object. The schema currently requires it to be a string, and that's what this PR fixes (at least once the typo I mentioned above is fixed). |
wimleers
added a commit
to wimleers/json-api
that referenced
this pull request
Mar 8, 2019
Probably caused by your IDE's autocompletion :) (Fixing this per json-api#1379 (review).)
|
Created PR to fix my comment above (#1379 (review)) |
Probably caused by your IDE's autocompletion :) (Fixing this per json-api#1379 (review).)
|
Thanks Wim! |
|
LGTM! 🚢 EDIT: as they say, the proof is in the pudding: https://www.drupal.org/project/jsonapi/issues/3037852#comment-13004970 :) |
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.
As a rule, our JSON:API implementation uses link objects for every link. This ensures clients written against our implementation are maximally forward compatible (so they don't break if and when a link has metadata added to it).
We've even applied this rule to pagination links. We've recently discovered that our responses are failing validation for this reason.
It seems like this is a small oversight in the schema and is not an intentional validation rule.
I need to validate that this schema change is correct tomorrow. However, I wanted to throw the PR out there for any initial reactions in case it actually is intentional and I've missed something. Therefore, I'm leaving this as a draft (which, BTW, is a nifty new GH feature!).