fix(json-schema): Validate document's links according to the JSONAPI specification #1487
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
7ee016b to
c899c75
Compare
c899c75 to
0ebec29
Compare
adilaid
approved these changes
Dec 27, 2020
auvipy
approved these changes
Jan 22, 2021
Toronto00
approved these changes
Feb 17, 2021
Toronto00
approved these changes
Feb 17, 2021
|
@guillemcanal thanks for working on this! I reviewed this with @gabesullice and we both agree it looks to be an improvement. @Relequestual as our "resident" JSON Schema expert, would you mind reviewing? |
|
@dgeb I'd be happy to. Mentioned here: #1522 (comment) I'm building a compliance suite and it's taken a little longer than expected, but I'll get back to fixing the schema for 1.0 soon, likely Monday. |
|
Closing in favor of #1555 |
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.
Hi,
I believe that the current JSON Schema do not reflect the written specification regarding document's links and pagination links.
allOfkeyword is misused in#/definitions/success/properties/links.According to the JSON Schema spec:
next,prev,last,first) MAY be either a#/definitions/linkornullI tested the fix against various examples provided on the JSONAPI website such as:
A resource with links:
{ "data": { "type": "articles", "id": "1", "attributes": { "title": "Rails is Omakase" }, "relationships": { "author": { "links": { "self": "/articles/1/relationships/author", "related": "/articles/1/author" }, "data": { "type": "people", "id": "9" } } } } }A collection with pagination links as
string{ "meta": { "totalPages": 13 }, "data": [ { "type": "articles", "id": "3", "attributes": { "title": "JSON:API paints my bikeshed!", "body": "The shortest article. Ever.", "created": "2015-05-22T14:56:29.000Z", "updated": "2015-05-22T14:56:28.000Z" } } ], "links": { "self": "http://example.com/articles?page%5Bnumber%5D=3&page%5Bsize%5D=1", "first": "http://example.com/articles?page%5Bnumber%5D=1&page%5Bsize%5D=1", "prev": "http://example.com/articles?page%5Bnumber%5D=2&page%5Bsize%5D=1", "next": "http://example.com/articles?page%5Bnumber%5D=4&page%5Bsize%5D=1", "last": "http://example.com/articles?page%5Bnumber%5D=13&page%5Bsize%5D=1" } }A collection with pagination links as
linkobjects:{ "meta": { "totalPages": 13 }, "data": [ { "type": "articles", "id": "3", "attributes": { "title": "JSON:API paints my bikeshed!", "body": "The shortest article. Ever.", "created": "2015-05-22T14:56:29.000Z", "updated": "2015-05-22T14:56:28.000Z" } } ], "links": { "self": { "href": "http://example.com/articles?page%5Bnumber%5D=3&page%5Bsize%5D=1"}, "first": { "href": "http://example.com/articles?page%5Bnumber%5D=1&page%5Bsize%5D=1"}, "prev": { "href": "http://example.com/articles?page%5Bnumber%5D=2&page%5Bsize%5D=1"}, "next": { "href": "http://example.com/articles?page%5Bnumber%5D=4&page%5Bsize%5D=1"}, "last": { "href": "http://example.com/articles?page%5Bnumber%5D=13&page%5Bsize%5D=1"} } }A collection with a
nullpagination links:{ "meta": { "totalPages": 13 }, "data": [ { "type": "articles", "id": "3", "attributes": { "title": "JSON:API paints my bikeshed!", "body": "The shortest article. Ever.", "created": "2015-05-22T14:56:29.000Z", "updated": "2015-05-22T14:56:28.000Z" } } ], "links": { "first": null, "prev": null, "next":null, "last": null } }A collection with mixed links (standard links and pagination links)
{ "meta": { "totalPages": 13 }, "data": [ { "type": "articles", "id": "3", "attributes": { "title": "JSON:API paints my bikeshed!", "body": "The shortest article. Ever.", "created": "2015-05-22T14:56:29.000Z", "updated": "2015-05-22T14:56:28.000Z" } } ], "links": { "foo": { "href": "https://foo.com/bar", "mata": { "bar": "baz" } }, "self": "http://example.com/articles?page%5Bnumber%5D=13&page%5Bsize%5D=1", "first": "http://example.com/articles?page%5Bnumber%5D=1&page%5Bsize%5D=1", "prev": "http://example.com/articles?page%5Bnumber%5D=12&page%5Bsize%5D=1", "next": null, "last": "http://example.com/articles?page%5Bnumber%5D=13&page%5Bsize%5D=1" } }