[Meta] JSON:API 1.1 spec compliance/support

Open on Drupal.org →

Created on 22 August 2022, over 2 years ago

Updated 4 August 2023, over 1 year ago

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.

#3279366: [PP-1] Implement json:api 1.1 server-required profile error handling/signaling →
📌 [PP-1] JSON:API 1.1 Implement `error.source.missing.key` data to compliment `error.source.pointer` Active

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

📌 Spec Compliance: JSON API's profile/extention (Fancy Filters, Drupal sorting, Drupal pagination, relationship arity) needs to be explicitly communicated Active

Changelog for releases after 1.0

RC 1

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.

RC 2

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.

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.

🌱 Plan

Status

Active

Version

11.0 🔥

Component

Last updated 12 days ago

Maintained by
@e0ipso
🇳🇱Netherlands @bbrala
@gabesullice
🇧🇪Belgium @wim leers

Created by

🇺🇸United States bradjones1 Digital Nomad Life

Live updates comments and jobs are added and updated live.

Spec Compliance

Incomplete comments

Sign in to follow issues

Comments & Activities

Not all content is available!

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

Comment over 1 year ago →
🇳🇱Netherlands bbrala Netherlands
I will be shifting focus to this starting next week.
Comment over 1 year ago →
🇧🇪Belgium wim leers Ghent 🇧🇪🇪🇺
🥳
Comment over 1 year ago →
🇳🇱Netherlands bbrala Netherlands
Comment over 1 year ago →
🇳🇱Netherlands bbrala Netherlands
Comment over 1 year ago →
🇳🇱Netherlands bbrala Netherlands
Comment over 1 year 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 ✨ Introduce "schematic" normalizers Active . Also bumping the version to 1.1 there because we basically support some of it anyway and should start expressing so.
Status changed to Needs work 3 months ago8:15am 6 January 2025
Comment 3 months ago →
🇧🇪Belgium wim leers Ghent 🇧🇪🇪🇺
✨ Introduce "schematic" normalizers Active 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! 😄

contrib.social Blog FAQ Discussions

Production build 0.71.5 2024