JSONAPI-Resources / JSONAPI-Resources/jsonapi-resources

Related endpoints for STI resources do not yield proper types

Offen
#772 3 Kommentare 1 Reaktion 0 zugewiesene Personen Auf GitHub ansehen

Dieses Issue hat noch niemand übernommen.

Type: Bug
Vorherrschende Sprache
Ruby
Sterne
2.3k
Forks
546
PR-Merge-Kennzahlen
Keine gemergten PRs in 30 T.

Beschreibung

Following up on #507

Given a model Animal with subclasses Cat and Dog, types get returned properly when querying directly for animals - e.g. hitting endpoint "api/animals" responds with types "cats" and "dogs" in the payload.

However, this behavior is not consistent when hitting the related endpoints of a resource - e.g. hitting "api/zoos/7/animals" responds with only type "animals" in the payload.

Currently, I am including "type" in the attributes object, which raises a warning and also breaks the JSON API specs. Is there a better workaround for this?

Beitragsleitfaden

Für dieses Repository ist kein Beitragsleitfaden indexiert

Erste Schritte

  1. Lies das ganze Issue und danach den Beitragsleitfaden des Projekts.
  2. Schreib ins Issue, dass du es übernimmst — das erspart doppelte Arbeit.
  3. Forke das Repository und arbeite in einem Branch.
  4. Öffne einen Pull Request, der die Issue-Nummer nennt.

Rechercherichtung

Reproduziere das STI-Verhalten mit den Animal-Unterklassen Cat und Dog, indem du api/animals mit api/zoos/7/animals vergleichst. Verfolge zuerst die Verarbeitung des Related-Resource-Endpoints; abgeschlossen ist die Aufgabe, wenn die Related-Response cats und dogs mit gültigen JSON:API-Typen meldet, ohne type zu den Attributen hinzuzufügen oder eine Warnung auszulösen.

Vom Indexierungsmodell aus dem Issue-Text verfasst.

Bewertung

Tech-Stack
rails, ruby
Bereich
api, backend
Issue-Typ
Bug
Schwierigkeit
4/5
Geschätzter Aufwand
3-5 Tage
Aktivitätsstatus
Veraltet
Klarheit
Muss geklärt werden
Anfängerfreundlichkeit
30/100

Neue Issues direkt in Ihr Postfach

Eine kurze Übersicht über anfängerfreundliche GitHub-Issues.