Update JSON Schema to be v1.0 compliant #1600

VGirol · 2021-12-22T23:16:14Z

I allowed myself to continue the work started by Relequestual in the pull request #1555.
I've updated the JSON schema for version 1.0 and added many sample files to test it. In these sample files there are both valids and invalids documents.
I've also added a JSON schema which allows to validate requests for creating new resources (still for the 1.0 version).
I hope this will help.
if that's okay with you, i could do the same for version 1.1.

closes #1127
closes #1554
closes #1522
closes #867

auvipy · 2021-12-23T05:00:03Z

amazing work dude

bradjones1 · 2022-01-11T20:04:16Z

Thank you for the awesome work. It seems that we could wire up a CI job to test the schema file against the fixtures you've provided using, say, ajv?

_schemas/1.0/schema.json

auvipy · 2022-01-12T15:11:02Z

@dgeb @gabesullice

auvipy

Looks great

VGirol · 2022-01-24T14:03:14Z

According to this PR #1127, i've added a schema to validate requests that update a resource or relationship.

VGirol · 2022-02-08T13:39:27Z

Actually, the JSON schema for v1.0 uses the draft-07 version.
Do we keep this version ? Or do i need to upgrade to the latest version (2020-12) ?

VGirol · 2022-02-08T14:12:31Z

Once this pr is merged (and the #1603 also), we can update the reference in https://github.com/SchemaStore/schemastore (see #1011 ).

VGirol · 2022-02-08T14:24:24Z

I read this comment (#975 (comment)) and I realized that by modifying the tree structure (and the schema file name), I introduced some backward breaks.
Do you think this is a big problem ?

VGirol · 2022-05-07T13:43:13Z

Could someone tell me what is missing for this PR to be merged ?

bradjones1

Same as #1603 (review) on 1.1; typo s/forbiden/forbidden

_schemas/1.0/schema.json

VGirol · 2022-05-10T12:34:49Z

Oups. Shame on me.
It's corrected.

derekwsgray · 2022-06-10T16:48:51Z

Woah! Wish I'd found this a couple days ago - Took a while to realize the schema linked on the jsonapi.org page is not valid (blocker was relationships vs relationshipsFromRequest)
I'm pasting all of this into our openapi.json spec

This really needs to be on the website! Thank you!

dgeb · 2022-06-10T16:52:38Z

This really needs to be on the website!

@derekwsgray Agreed, this is a high priority!

@VGirol Thanks so much for your hard work on this. I'll finish reviewing this very soon.

derekwsgray · 2022-06-10T17:33:41Z

There are some places that don't work in OpenAPI 3.1 (thought I thought all of json schema should have worked.)
Example, the resource schema uses allOf as a sibling to properties, whereas OpenAPI expects allOf to contain that object with properties as a second child. (hope that makes sense.)

auvipy · 2022-06-10T17:42:58Z

There are some places that don't work in OpenAPI 3.1 (thought I thought all of json schema should have worked.) Example, the resource schema uses allOf as a sibling to properties, whereas OpenAPI expects allOf to contain that object with properties as a second child. (hope that makes sense.)

did you check the v1.1 complaint schema PR #1603 ? would love to have some review

derekwsgray · 2022-06-10T17:45:40Z

did you check the v1.1 complaint schema PR #1603 ? would love to have some review

Nope, didn't realize it existed!

auvipy · 2022-07-12T22:51:03Z

This really needs to be on the website!

@derekwsgray Agreed, this is a high priority!

@VGirol Thanks so much for your hard work on this. I'll finish reviewing this very soon.

should we consider this and the v 1.1 json-schema updates for v1.1 final release?

jelhan

Thanks a lot for this awesome work!

I left a few minor comments on the test cases. Please have a look.

I haven't reviewed the JSON Schema itself (yet). I'm not an expert on JSON Schema. The extensive test cases helps me a lot to verify correctness of the JSON Schema. Thanks a lot for putting that much time into them!

Do you mind resetting all changes, which are not related to the JSON Schema? Especially the changes to _format/1.1/index.md, examples/index.md, implementations/index.md, and recommendations/index.md?

Could we have /schema as a HTTP redirect to _schemas/1.0/schema.json? Or could we maybe copy it over when building the website? I worry that users may rely on that URL to fetch latest version of the schema. Would be great to have it as an alias pointing to the schema of the latest stable version.

Would be great if you could add documentation how to run the tests for the JSON Schema. CONTRIBUTING.md seems to be a good fit for it.

Additionally we should run the tests with the schema in GitHub actions. Do you mind setting CI up?

@dgeb I think we should try to land this first and than build the schema for v1.1 on top of it. What do you think?

...mas/1.0/tests/request/resource/create/invalid/relationship_with_bad_resource_identifier.json

_schemas/1.0/tests/request/resource/create/valid/post_resource.json

_schemas/1.0/tests/request/resource/update/valid/patch_resource.json

_schemas/1.0/tests/response/invalid/errors/invalid_error_objects.json

_schemas/1.0/tests/response/invalid/relationships/to_many_linkage_twice.json

_schemas/1.0/tests/response/invalid/resource/relationship_named_id.json

VGirol · 2022-08-12T21:44:45Z

Do you mind resetting all changes, which are not related to the JSON Schema? Especially the changes to _format/1.1/index.md, examples/index.md, implementations/index.md, and recommendations/index.md?

These changes are present on the PR for version 1.1 (#1603). I don't know why they appear in this PR. I will remove them quickly.

Could we have /schema as a HTTP redirect to _schemas/1.0/schema.json? Or could we maybe copy it over when building the website? I worry that users may rely on that URL to fetch latest version of the schema. Would be great to have it as an alias pointing to the schema of the latest stable version.

It's a good idea, but I'm not sure I can make it happen. I don't know how the website is built. I'll take a look soon...

Would be great if you could add documentation how to run the tests for the JSON Schema. CONTRIBUTING.md seems to be a good fit for it.

Well, i've used an hand-made validator coded in PHP.

Additionally we should run the tests with the schema in GitHub actions. Do you mind setting CI up?

I've never set up CI. I'm going to try...

bradjones1 · 2022-08-12T23:00:07Z

ajv is a great tool for validating json-schema, it can also validate a schema against the meta-schema, as would be the case here as well. I've set up CI for something like this for proprietary/in house projects before, if you'd like the help.

Add meta member to all test files with informations about errors present in the document.

…hemas based on the results of the script.

…ne using files from previous versions

This reverts commit 8ce88f1.

VGirol · 2023-09-22T07:38:51Z

Well, i've rebased the branch to the main branch and forced-pushed the result (but i'm not sure it was a good idea...).

auvipy

you most probably put the node_modules in gitignore?

auvipy · 2023-11-13T04:33:55Z

_schemas/1.0/schema_create_resource.json

@@ -1,5 +1,5 @@
 {
-  "$schema": "http://json-schema.org/draft-07/schema#",


regarding the schema version we will be using in v1.0, we need to get input from community experts. may be using the latest schema version with v1.0 specs is OK somehow

I don't see any harm in using the latest version, but it's up to you. Let's see what the community experts think about it.

By now i would say, just use the latest version

VGirol · 2023-11-13T10:16:35Z

you most probably put the node_modules in gitignore?

The node_modules is already put in gitignore.

VGirol · 2023-11-13T10:33:18Z

you most probably put the node_modules in gitignore?

The node_modules is already put in gitignore.

Ok, sorry, i saw what you meant : I removed the node_modules from PR.

auvipy · 2023-12-06T16:43:17Z

@dgeb Dan it would be great if you could have a look when you have some free time!

CoolGoose · 2024-05-17T14:54:58Z

Hello folks, any updates in this area ?

orsinium · 2024-05-21T13:24:48Z

Might this PR be the reason why the old link to the schema is dead?

https://jsonapi.org/schema

The link above is referenced in FAQ:

https://jsonapi.org/faq/#is-there-a-json-schema-describing-json-api

igneus · 2024-06-05T18:59:56Z

Yes. This PR made https://jsonapi.org/schema unavailable, not providing a (reachable) replacement.

bradjones1 mentioned this pull request Jan 11, 2022

JSON Schema for JSON:API v1.0 is incomplete or broken #1554

Closed

bradjones1 reviewed Jan 12, 2022

View reviewed changes

_schemas/1.0/schema.json Show resolved Hide resolved

Relequestual mentioned this pull request Jan 12, 2022

Update JSON Schema to be v1.0 compliant #1555

Closed

auvipy mentioned this pull request Jan 13, 2022

Is JSON:API 1.1 release waiting for implementations? #1578

Closed

auvipy reviewed Jan 19, 2022

View reviewed changes

VGirol closed this Feb 8, 2022

VGirol reopened this Feb 8, 2022

jelhan added the json-schema label Feb 17, 2022

bradjones1 suggested changes May 10, 2022

View reviewed changes

_schemas/1.0/schema.json Outdated Show resolved Hide resolved

_schemas/1.0/schema.json Outdated Show resolved Hide resolved

_schemas/1.0/schema.json Outdated Show resolved Hide resolved

auvipy mentioned this pull request Aug 5, 2022

Add JSON Schema that is v1.1 compliant #1603

Open

jelhan requested changes Aug 10, 2022

View reviewed changes

VGirol force-pushed the schema-1.0 branch 2 times, most recently from 8e90d52 to abd872c Compare August 10, 2022 15:18

VGirol added 17 commits September 22, 2023 08:46

Change all title to more neutral text.

1bec0a0

Add meta member to all test files with informations about errors present in the document.

Add script to valide JSON schema against all test files and update sc…

967e17c

…hemas based on the results of the script.

Add documentation on how to run the tests for the JSON Schemas

3b954d4

Update validation script of JSON Schema so that validation is also do…

46427f7

…ne using files from previous versions

script linting

cc50fdd

Revert "script linting"

e955058

This reverts commit 8ce88f1.

Script linting

12cdaa8

Enhance script output

abdd582

Enhance readability

0b97835

Add -f and -v options to test script

424a84b

Fix typo

3291313

Add test-schema to CI

cdd7b4b

Fix typo in bash command to run script

0cf8847

Change trigger for the "Schema validation test" workflow

f1a98bf

Allow for parallel relationships in JSON Schema

fae1d42

Bump ajv version

31b120a

Update to latest version of json-schema

f3a8aa7

VGirol force-pushed the schema-1.0 branch from 5c111d8 to f3a8aa7 Compare September 22, 2023 07:33

auvipy suggested changes Nov 13, 2023

View reviewed changes

Remove node_modules

5555fa9

dgeb merged commit af47518 into json-api:gh-pages May 19, 2024

bradjones1 mentioned this pull request Jun 26, 2024

JSON Schema is not publicly available #1749

Open

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Update JSON Schema to be v1.0 compliant #1600

Update JSON Schema to be v1.0 compliant #1600

VGirol commented Dec 22, 2021 •

edited

Loading

auvipy commented Dec 23, 2021

bradjones1 commented Jan 11, 2022

auvipy commented Jan 12, 2022

auvipy left a comment

VGirol commented Jan 24, 2022

VGirol commented Feb 8, 2022

VGirol commented Feb 8, 2022

VGirol commented Feb 8, 2022 •

edited

Loading

VGirol commented May 7, 2022

bradjones1 left a comment

VGirol commented May 10, 2022

derekwsgray commented Jun 10, 2022

dgeb commented Jun 10, 2022

derekwsgray commented Jun 10, 2022

auvipy commented Jun 10, 2022

derekwsgray commented Jun 10, 2022

auvipy commented Jul 12, 2022

jelhan left a comment

VGirol commented Aug 12, 2022

bradjones1 commented Aug 12, 2022

VGirol commented Sep 22, 2023

auvipy left a comment

auvipy Nov 13, 2023

VGirol Nov 13, 2023

bbrala May 10, 2024

VGirol commented Nov 13, 2023

VGirol commented Nov 13, 2023

auvipy commented Dec 6, 2023

CoolGoose commented May 17, 2024

orsinium commented May 21, 2024

igneus commented Jun 5, 2024

		@@ -1,5 +1,5 @@
		{
		"$schema": "http://json-schema.org/draft-07/schema#",

Update JSON Schema to be v1.0 compliant #1600

Update JSON Schema to be v1.0 compliant #1600

Conversation

VGirol commented Dec 22, 2021 • edited Loading

auvipy commented Dec 23, 2021

bradjones1 commented Jan 11, 2022

auvipy commented Jan 12, 2022

auvipy left a comment

Choose a reason for hiding this comment

VGirol commented Jan 24, 2022

VGirol commented Feb 8, 2022

VGirol commented Feb 8, 2022

VGirol commented Feb 8, 2022 • edited Loading

VGirol commented May 7, 2022

bradjones1 left a comment

Choose a reason for hiding this comment

VGirol commented May 10, 2022

derekwsgray commented Jun 10, 2022

dgeb commented Jun 10, 2022

derekwsgray commented Jun 10, 2022

auvipy commented Jun 10, 2022

derekwsgray commented Jun 10, 2022

auvipy commented Jul 12, 2022

jelhan left a comment

Choose a reason for hiding this comment

VGirol commented Aug 12, 2022

bradjones1 commented Aug 12, 2022

VGirol commented Sep 22, 2023

auvipy left a comment

Choose a reason for hiding this comment

auvipy Nov 13, 2023

Choose a reason for hiding this comment

VGirol Nov 13, 2023

Choose a reason for hiding this comment

bbrala May 10, 2024

Choose a reason for hiding this comment

VGirol commented Nov 13, 2023

VGirol commented Nov 13, 2023

auvipy commented Dec 6, 2023

CoolGoose commented May 17, 2024

orsinium commented May 21, 2024

igneus commented Jun 5, 2024

VGirol commented Dec 22, 2021 •

edited

Loading

VGirol commented Feb 8, 2022 •

edited

Loading