[Meta] JSON:API 1.1 spec compliance/support

Created on 22 August 2022, almost 2 years ago

Updated 16 October 2023, 8 months ago

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

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:

Recommending camelCased
Extensions 📌 Spec Compliance: JSON API's profile/extention (Fancy Filters, Drupal sorting, Drupal pagination, relationship arity) needs to be explicitly communicated Active
Profiles 📌 Spec Compliance: JSON API's profile/extention (Fancy Filters, Drupal sorting, Drupal pagination, relationship arity) needs to be explicitly communicated Active
Links can be represented as RFC 8288-style web links.
describedby links member was added ✨ JSON:API 1.1: Add descibeBy API to add link to top level, resource and relationship objects Active
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.
Clarified details regarding expected and allowed responses, query parameters, and more.

New features include: profiles, ”@-Members”, and error object type links.
There are editorial clarifications around: query parameters (their parsing/serialization, and reserved parameter names), the appropriate status code for specific responses, and the presence of the included key even when its value is an empty array.
JSON:API switched to recommending camelCased names.

Extensions were added and the scope of profiles were reduced since their introduction in RC1.
Links can be represented as RFC 8288-style web links.
A new describedby links member was added so that implementors can incorporate description documents (e.g. OpenAPI or JSON Schema) directly into their APIs.
Local IDs were introduced so that a client can create a relationship to a resource yet-to-be created by the same request.

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.

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.

🌱 Plan

Status

Active

Version

11.0 🔥

Component

JSON API →

Last updated 2 days ago

Created by

🇺🇸United States bradjones1 Digital Nomad Life

Live updates comments and jobs are added and updated live.

Incomplete comments

Comments & Activities

Not all content is available!

It's likely this issue predates Contrib.social: some issue and comment data are missing.

Comment 11 months ago →
🇳🇱Netherlands bbrala Netherlands
I will be shifting focus to this starting next week.
Comment 11 months ago →
🇧🇪Belgium Wim Leers Ghent 🇧🇪🇪🇺
🥳
Comment 10 months ago →
🇳🇱Netherlands bbrala Netherlands
Comment 10 months ago →
🇳🇱Netherlands bbrala Netherlands
Comment 10 months ago →
🇳🇱Netherlands bbrala Netherlands
Comment 8 months ago →
🇺🇸United States bradjones1 Digital Nomad Life
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 ✨ Generate JSON schema for content entity types Needs review . Also bumping the version to 1.1 there because we basically support some of it anyway and should start expressing so.

Production build 0.69.0 2024