Update to JSON:API v1.1 #461
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
ml-evs
reviewed
Mar 19, 2023
…schema from RECOMMENDED and clarify the replacement field.
rartino
commented
Mar 19, 2023
ml-evs
previously approved these changes
Mar 20, 2023
JPBergsma
reviewed
Mar 20, 2023
merkys
reviewed
Mar 20, 2023
rartino
commented
Jun 9, 2023
|
Workshop merge this, after fixing the comment above. |
ml-evs
reviewed
Jun 9, 2023
rartino
commented
Jun 11, 2023
rartino
commented
Jun 11, 2023
|
This is now waiting for (re)reviews. |
rartino
added
the
PR/ready-for-review
merkys
reviewed
Jun 12, 2023
merkys
reviewed
Jun 12, 2023
Co-authored-by: Andrius Merkys <[email protected]>
merkys
previously approved these changes
Jun 13, 2023
|
Ping @ml-evs |
ml-evs
reviewed
Jun 14, 2023
ml-evs
previously approved these changes
Jun 17, 2023
ml-evs
reviewed
Jun 17, 2023
ml-evs
reviewed
Jun 17, 2023
ml-evs
reviewed
Jun 17, 2023
ml-evs
reviewed
Jun 17, 2023
ml-evs
reviewed
Jun 17, 2023
rartino
commented
Jun 17, 2023
Sure, we could start collecting them in #475? |
ml-evs
reviewed
Jun 17, 2023
ml-evs
previously approved these changes
Jun 17, 2023
merkys
previously approved these changes
Jun 20, 2023
ml-evs
reviewed
Jun 20, 2023
ml-evs
approved these changes
Jun 20, 2023
merkys
approved these changes
Jun 20, 2023
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.
This is a set of changes that I think is what is needed (and useful) for updating the specification to JSON:API v1.1.
The primary reason I push for this is to be optionally allowed to include a top level "@context" to describe an OPTIMADE response as linked data as that is useful for #445. This is allowed in v1.1 but not in v1.0.
I've deprecated (but not removed) the old way of specifying a schema in favor of the more official JSON:API way.
I've consistently updated "JSON API" to "JSON:API" since that seems to be how it is supposed to be written.
I've also added documentation on a couple of OPTIONAL fields that arguably were already allowed from us adhering to JSON:API, but we've discussed is useful as we progress. E.g., the toplevel
jsonapito identify responses to be OPTIMADE responses.