Modify Plugs.DataToAttributes to follow JSON API sideposting draft

Offen

#1,303 erstellt am 18.12.2017 1 Kommentar 0 Reaktionen 0 zugewiesene Personen Auf GitHub ansehen

Dieses Issue hat noch niemand übernommen.

Bewertung

Schwierigkeit: 3/5
Geschätzter Aufwand: 1-2 Tage
Anfängerfreundlichkeit: 35/100

Issue-Typ: Feature
Klarheit: Größtenteils klar
Aktivitätsstatus: Veraltet
Tech-Stack: elixir
Bereich: api, backend

Rechercherichtung

Beginnen Sie mit dem im Issue referenzierten DataToAttributes-Code und überprüfen Sie, wie JaSerializer.Params.to_attributes Beziehungen vom Typ belongs-to behandelt. Prüfen Sie den JSON API sideposting draft und issue #1301, bevor Sie das Verhalten ändern. Als erledigt gilt die Aufgabe, wenn Array-Beziehungen temp-id-Identifiers verwenden, um übereinstimmende inkludierte Datensätze auszuwählen, während Map-Beziehungen weiterhin von JaSerializer.Params.to_attributes behandelt werden.

Vom Indexierungsmodell aus dem Issue-Text verfasst.

Beschreibung

blocked

Problem

From https://github.com/json-api/json-api/pull/1197/files?short_path=571f6ce#diff-571f6cee9a492e0e177801c21a4b2b2a

Our current approach with included records is to simply assume they are related to the main record.

Based on the draft

included record payloads should have temp-id properties if they are to be created.
the main record payload should have a relationship where the identifier is %{data: [%{"temp-id" => "foo", "type" => "bar"}
the plug should get those identifiers, then replace the identifier payloads with the associated full payloads matched in included

Subtasks

instead of just taking any included records and assuming they're relationships in the resulting params map, DataToAttributes should parse the relationships map first
- the relationship where data is a map is a belongs to and should be left alone. it's already handled by JaSerializer.Params.to_attributes
- the relationship where data is an array should be checked for identifiers with temp-id keys
  - each temp-id should be found in the included section and added under the pluralized relationship key in the resulting map

An advantage of this is that we now are able to conclude it's definitely a has_many, so we do not need to explicitly specify this anymore.

References

The code this needs to modify is part of #1301 so this is blocked until that is merged.

Vorherrschende Sprache: Elixir
Sterne: 234
Forks: 82
PR-Merge-Kennzahlen: Keine gemergten PRs in 30 T.

Beitragsleitfaden

Beitragsleitfaden öffnen

Erste Schritte

Lesen Sie das ganze Issue und danach den Beitragsleitfaden des Projekts.
Schreiben Sie ins Issue, dass Sie es übernehmen — das erspart doppelte Arbeit.
Forken Sie das Repository und arbeiten Sie in einem Branch.
Öffnen Sie einen Pull Request, der die Issue-Nummer nennt.

Mehr aus code-corps/code-corps-api

URGENT: Security vulnerability detected in infrastructure config Offen

Schwierigkeit 5/5 Über eine Woche Anfängerfreundlichkeit 15/100

code-corps/code-corps-api#1385 · Erstellt am 06.1.2026
Cannot Create new GitHub App Offen

Schwierigkeit 3/5 1-2 Tage Anfängerfreundlichkeit 25/100

code-corps/code-corps-api#1384 · Erstellt am 12.12.2019
Track anon Users that register Offen

Schwierigkeit 4/5 3-5 Tage Anfängerfreundlichkeit 35/100

code-corps/code-corps-api#1383 · 2 Kommentare · Erstellt am 12.3.2018
Use Dependabot to automatically keep dependencies up-to-date Offen

Schwierigkeit 3/5 1-2 Tage Anfängerfreundlichkeit 35/100

code-corps/code-corps-api#1382 · 2 Kommentare · Erstellt am 11.3.2018
Write tests for GitHub.Sync.pull_request_event/1 Offen

Difficulty: Medium Skill: Elixir Time: 4 hours

code-corps/code-corps-api#1372 · 3 Kommentare · 1 zugewiesene Person · Erstellt am 17.1.2018

Alle Issues in code-corps/code-corps-api