Add arity key on field data returned by jsonapi

Created on 15 April 2022, almost 3 years ago
Updated 26 September 2024, 6 months ago

Problem/Motivation

#2864680: Spec Compliance: JSON API's schema disallows duplicate resource identifiers. EntityReferenceItems which reference the same entity must have an "arity" added an arity key to relationships returned by jsonapi to avoid an error when a reference field contains the same entity multiple times.

However, we have a similar problem when returning data about a specific field.
The previous fix only applies to ResourceIdentifier, but when querying a field, jsonapi returns normalized ResourceObject and those don't have an arity key.

Steps to reproduce

  1. Create an entity with a reference field and add the same entity multiple times in this reference field.
  2. Browse to /jsonapi/[entity_type]/[bundle]/[uuid]/[field_name] (real life example: /jsonapi/paragraph/carrousel/2f03a78f-1d0a-43e5-a6ee-6fb0fd8a90f7/field_images).
  3. You get this error:

    A JSON:API response failed validation (see the logs for details). Please report this in the issue queue on drupal.org

(However /jsonapi/[entity_type]/[bundle]/[uuid] does not have the same error because there, the relationship has arity keys.)

Proposed resolution

jsonapi should add an arity key on duplicated ResourceObject objects.

The arity logic from ResourceIdentifier should probably be refactorized to be used by other classes.

🐛 Bug report
Status

Active

Version

11.0 🔥

Component
JSON API 

Last updated 8 days ago

Created by

🇫🇷France prudloff Lille

Live updates comments and jobs are added and updated live.
Sign in to follow issues

Merge Requests

Comments & Activities

Not all content is available!

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

  • 🇫🇷France GaëlG Lille, France

    gaëlg made their first commit to this issue’s fork.

  • 🇫🇷France GaëlG Lille, France

    gaëlg changed the visibility of the branch 3275497-add-arity-key to hidden.

  • Pipeline finished with Failed
    6 months ago
    Total: 152s
    #293110
  • Pipeline finished with Canceled
    9 days ago
    Total: 328s
    #441338
  • Pipeline finished with Failed
    9 days ago
    Total: 356s
    #441342
  • Pipeline finished with Failed
    9 days ago
    Total: 417s
    #441360
  • Status changed to Needs work 9 days ago
  • 🇫🇷France prudloff Lille

    I need to fix related tests.

  • Pipeline finished with Failed
    9 days ago
    Total: 76s
    #441435
  • Pipeline finished with Failed
    9 days ago
    Total: 729s
    #441436
  • Pipeline finished with Failed
    9 days ago
    Total: 655s
    #441450
  • Pipeline finished with Failed
    8 days ago
    Total: 563s
    #441637
  • Pipeline finished with Success
    8 days ago
    Total: 837s
    #441653
  • 🇫🇷France prudloff Lille

    The MR adds the arity key to every resource even if not necessary (for example on responses containing a single resource).
    It keeps the code simple and more predictable, but it means a lot of tests had to be updated.

  • 🇺🇸United States smustgrave

    Left comments/questions in MR.

  • Pipeline finished with Success
    8 days ago
    Total: 309s
    #442146
Production build 0.71.5 2024