Problem/Motivation

This issue tracks child issues relating to JSON:API 1.1 spec compliance. The announced tag date for 1.1 is September 30, 2022.

Reference: Changelist

Remaining tasks

Areas where Drupal is not 1.0 compliant but we were ahead of 1.1; ensure tagged spec compliance.

Areas where Drupal is incompatible and there is no existing PP on JSON:API 1.1; that is, we're just plain out of spec.

New features/options in 1.1 that Drupal can support

Overview of all changes in spec and their releated issues:

Spec changelist

  1. #3386046: JSON:API 1.1: "@-Members"
  2. error object type links.
    1. #3279364: [PP-1] JSON:API 1.1 Implement `error.source.missing.key` data to compliment `error.source.pointer`
  3. Recommending camelCased
  4. Extensions #2955020: Spec Compliance: JSON API's profile/extention (Fancy Filters, Drupal sorting, Drupal pagination, relationship arity) needs to be explicitly communicated
  5. Profiles #2955020: Spec Compliance: JSON API's profile/extention (Fancy Filters, Drupal sorting, Drupal pagination, relationship arity) needs to be explicitly communicated
  6. Links can be represented as RFC 8288-style web links.
  7. describedby links member was added #3386063: JSON:API 1.1: Add descibeBy API to add link to top level, resource and relationship objects
  8. Local IDs were introduced so that a client can create a relationship to a resource yet-to-be created by the same request. I don't think we need to do this, we dont really allow creating multple resource in one request.
  9. The link object params member was removed
  10. The link object anchor target attribute was removed
  11. Clarified details regarding expected and allowed responses, query parameters, and more.

Changelog for releases after 1.0

RC 1

RC 2

RC 3

  • Refined links objects. The link object params member was removed to better align with other JSON link serializations. The anchor target attribute was also removed. It may be restored in a future minor release.

RC 4

  • Formalized the definition of specification and implementation semantics.
  • Refined the definitions of extensions and profiles.
  • Clarified details regarding expected and allowed responses, query parameters, and more.

Issue fork drupal-3305324

Command icon Show commands

Start within a Git clone of the project using the version control instructions.

Or, if you do not have SSH keys set up on git.drupalcode.org:

Comments

bradjones1 created an issue. See original summary.

bradjones1’s picture

Issue summary: View changes
bradjones1’s picture

Issue summary: View changes

bbrala made their first commit to this issue’s fork.

bbrala’s picture

Great overview. I started tracking changes on 1.1 in another issue though so this is kinda duplicate. I don't really mind which survives. This issue has issue links, the other one a set of changes that were published in the changelogs.

#3223015: [META] JSON:API v1.1

bbrala’s picture

Issue summary: View changes

Updated IS, will close the other issue in favor of this one since we have linkage going on which is quite helpfull :)

bradjones1’s picture

Ah OK sorry for the duplicate... one problem is that the Drupal search thinks "1.1" is too short a string to match on so I couldn't find it right away.

bbrala’s picture

Yeah had the same problem, but I knew it existed so I searched for meta :)

wim leers’s picture

Wow, very nice overview! Keeping an eye on this! 👁

wim leers’s picture

Priority: Normal » Major

13 days ago, the JSON:API 1.1 spec was finalized: https://jsonapi.org/format/1.1/ — so let's now make this happen!

Version: 10.1.x-dev » 11.x-dev

Drupal core is moving towards using a “main” branch. As an interim step, a new 11.x branch has been opened, as Drupal.org infrastructure cannot currently fully support a branch named main. New developments and disruptive changes should now be targeted for the 11.x branch, which currently accepts only minor-version allowed changes. For more information, see the Drupal core minor version schedule and the Allowed changes during the Drupal core release cycle.

bbrala’s picture

I will be shifting focus to this starting next week.

wim leers’s picture

🥳

bbrala’s picture

Issue summary: View changes
bbrala’s picture

Issue summary: View changes
bbrala’s picture

Issue summary: View changes
bradjones1’s picture

Per my update in #3258084-11: [PP-1] [Upstream bug] Vendored json-schema for json:api is incorrect I have reason to include the latest draft of the 1.1 JSON Schema in the changes on #3031367: Generate JSON schema for content entity types. Also bumping the version to 1.1 there because we basically support some of it anyway and should start expressing so.

wim leers’s picture

Status: Active » Needs work

#3031367: Generate JSON schema for content entity types landed, including the bump to version 1.1 of the spec. I think this meta needs an update — yay, what a great problem to have! 😄

Version: 11.x-dev » main

Drupal core is now using the main branch as the primary development branch. New developments and disruptive changes should now be targeted to the main branch.

Read more in the announcement.