Add JSON Schema that is v1.1 compliant by VGirol · Pull Request #1603 · json-api/json-api · GitHub

I've only added sample files in relation with the new features of the 1.1 version.
I still have to add the rules regarding the @-members and the extension members.
Coming soon...

great job! thanks for handling this!

…ship

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

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) ?

1.1 should be latest jsonschema compliant, like openAPI 3.1 does, IMHO.

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

Addressing typo found during CI integration with Drupal's dictionary. s/forbiden/forbidden

Suggested change

      
                      "$ref": "#/definitions/relationshipsForbidenMemberName"
          
                      "$ref": "#/definitions/relationshipsForbiddenMemberName"

Suggested change

      
                      "$ref": "#/definitions/relationshipsForbidenMemberName"
          
                      "$ref": "#/definitions/relationshipsForbiddenMemberName"

Suggested change

      
                "relationshipsForbidenMemberName": {
          
                "relationshipsForbiddenMemberName": {

…ship

…schema-1.1

Corrected.

@dgeb can we consider this for 1.1?

@jelhan can you take a look here please?

@jelhan can you take a look here please?

To be honest I'm not an expert for JSON schema. But I agree that we need to improve in that regard. Thanks a lot for following up.

Personally I would feel much more comfortable with reviewing if we would have some test coverage for the schema. Like having a set of JSON:API documents, which are validated with the schema in CI.

Also it's unclear to me how we could version the schema. v1.1 is not stable yet formally. We might need at least two schemas: one for the current stable version and one for the upcoming version.

We may want to setup such an infrastructure before moving forward.

Just had a look at the proposed changes in this PR and noticed that it is already addressing some points I raised above. Seems to be a great starting point! 👏

yes there is another PR for the v1.0 :) #1600

I really appreciate this work and its importance for the spec. In my opinion, an official schema is not a blocker for the v1.1 release but it would be ideal to release both simultaneously. I think we stand a good chance to finalize the schema in the same time frame that the final v1.1 RC is being reviewed, without delaying either.

I really appreciate this work and its importance for the spec. In my opinion, an official schema is not a blocker for the v1.1 release but it would be ideal to release both simultaneously. I think we stand a good chance to finalize the schema in the same time frame that the final v1.1 RC is being reviewed, without delaying either.

thats a reasonable plan

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

Is there anything that is blocking this PR? :) Should I do something? Thank you

I think we can move with it after we complete merging the schema for v1.0

in fact we can move with it in 1.1 branch as well. in case v 1.0 need more work?

We must validate and merge v1.0 before merging it in 1.1 branch because this PR uses the validation script that is introduced in the #1600 (./_schemas/scripts/validator.js).

Ok great. Lets complete the v1.0 first

v1.0 seems complete, validator is merged. Think this could move forward.

Any chance this could be merged ^^

Pins the four unreleased JSON:API 1.1 draft-PR schemas (json-api/json-api#1603) and validates writer-generated bytes offline against them; schema acceptance is supplemental evidence only.

Add JSON Schema that is v1.1 compliant

966499a

Add schema to validate a request that update a resource or a relation…

d3954e0

…ship

VGirol mentioned this pull request Feb 8, 2022

Update JSON Schema to be v1.0 compliant #1600

Merged

Update schema to 2020-12 version and add @member checks

13a0ab3

jelhan added the json-schema label Feb 17, 2022

bradjones1 suggested changes May 10, 2022

View reviewed changes

VGirol added 5 commits May 10, 2022 14:35

Add JSON Schema that is v1.1 compliant

949dec7

Add schema to validate a request that update a resource or a relation…

ef1c692

…ship

Update schema to 2020-12 version and add @member checks

55ade72

Fix typo

07cc91b

Merge branch 'schema-1.1' of https://github.com/VGirol/json-api into …

e90b970

…schema-1.1

VGirol force-pushed the schema-1.1 branch 3 times, most recently from 7eeae6a to e90b970 Compare August 12, 2022 22:17

VGirol added 2 commits August 13, 2022 00:38

Change all title to more neutral text.

80ec1f8

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

Update schemas to be compliant with strict mode of ajv validator

5916f19

jelhan mentioned this pull request Oct 23, 2022

Provide JSON Schema for JSON:API 1.1 #1672

Open

Allow for parallel relationships in JSON schema v1.1

4ee1c64

auvipy approved these changes Sep 21, 2023

View reviewed changes

bradjones1 mentioned this pull request Jun 26, 2024

JSON Schema is not publicly available #1749

Open

VGirol mentioned this pull request Mar 3, 2025

The link to your json schema is broken #1788

Open

Armss9936 approved these changes Jul 24, 2025

View reviewed changes

Armss9936 approved these changes Oct 8, 2025

View reviewed changes

kazemek mentioned this pull request Aug 2, 2026

test(jackson3): cross-check writer fixtures against pinned draft schemas kazforge/jsonapi-java#36

Merged

+                    "type": "object",
+                    "allOf": [
+                      {
+                        "$ref": "#/definitions/relationshipsForbidenMemberName"

	"$ref": "#/definitions/relationshipsForbidenMemberName"
	"$ref": "#/definitions/relationshipsForbiddenMemberName"

	"relationshipsForbidenMemberName": {
	"relationshipsForbiddenMemberName": {

Add JSON Schema that is v1.1 compliant by VGirol · Pull Request #1603 · json-api/json-api · GitHub

Uh oh!

Add JSON Schema that is v1.1 compliant - #1603

Add JSON Schema that is v1.1 compliant#1603VGirol wants to merge 11 commits intojson-api:gh-pagesjson-api/json-api:gh-pagesfrom VGirol:schema-1.1VGirol/json-api:schema-1.1Copy head branch name to clipboard

Conversation

VGirol commented Jan 18, 2022 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

auvipy commented Jan 19, 2022

Uh oh!

VGirol commented Jan 24, 2022

Uh oh!

VGirol commented Feb 8, 2022

Uh oh!

auvipy commented Feb 8, 2022

Uh oh!

VGirol commented May 7, 2022

Uh oh!

bradjones1 left a comment

Choose a reason for hiding this comment

Uh oh!

bradjones1 May 10, 2022

Choose a reason for hiding this comment

Uh oh!

bradjones1 May 10, 2022

Choose a reason for hiding this comment

Uh oh!

bradjones1 May 10, 2022

Choose a reason for hiding this comment

Uh oh!

VGirol commented May 10, 2022

Uh oh!

auvipy commented Jun 10, 2022

Uh oh!

auvipy commented Aug 4, 2022

Uh oh!

jelhan commented Aug 4, 2022

Uh oh!

jelhan commented Aug 4, 2022

Uh oh!

auvipy commented Aug 5, 2022 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

dgeb commented Aug 5, 2022

Uh oh!

auvipy commented Aug 5, 2022

Uh oh!

VGirol commented Mar 23, 2023

Uh oh!

auvipy left a comment

Choose a reason for hiding this comment

Uh oh!

auvipy commented Nov 13, 2023

Uh oh!

VGirol commented Nov 13, 2023

Uh oh!

auvipy commented Nov 13, 2023

Uh oh!

bbrala commented Jul 10, 2024

Uh oh!

LarsStegman commented Sep 9, 2025

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

8 participants

Add JSON Schema that is v1.1 compliant#1603
VGirol wants to merge 11 commits into
json-api:gh-pagesfrom
VGirol:schema-1.1

VGirol commented Jan 18, 2022 •
edited
Loading

auvipy commented Aug 5, 2022 •
edited
Loading