JSONAPI-Resources / JSONAPI-Resources/jsonapi-resources

Polymorphic Relationships Not Found On Aliased Resource

Offen
#1,453 1 Kommentar 0 Reaktionen 0 zugewiesene Personen Auf GitHub ansehen

Dieses Issue hat noch niemand übernommen.

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

Beschreibung

This issue is a (choose one):

  • Problem/bug report.
  • Feature request.
  • Request for support. Note: Please try to avoid submitting issues for support requests. Use Gitter instead.

Checklist before submitting:

  • I've searched for an existing issue.
  • I've asked my question on Gitter and have not received a satisfactory answer.
  • I've included a complete bug report template. This step helps us and allows us to see the bug without trying to reproduce the problem from your description. It helps you because you will frequently detect if it's a problem specific to your project.
  • [] The feature I'm asking for is compliant with the JSON:API spec.

Description

We are using the v0-11-dev at risk.

If we define all that is necessary for a polymorphic relationship, we can include the related resources via something like GET /people/123?include=pets. Example code that works:

class PersonResource < JSONAPI::Resource
  relationship :pets, polymorphic: true, to: :many, polymorphic_types: %w[Cat Dog]
end

However if we "alias" the primary resource, the analogous request (GET /pet_owners/123?include=pets) does not find the related resources when we include the relationship:

  class PetOwnerResource < JSONAPI::Resource
    model_name 'Person'

    relationship :pets, polymorphic: true, to: :many, polymorphic_types: %w[Cat Dog]
end

It seems the related resource lookup is not taking into account that the primary/source resource might be aliased and using model_name.

Expected: the related resources are found.

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

Es wird keine Quelldatei oder kein Test genannt. Beginne damit, das Beispiel für die aliased PetOwnerResource mit GET /pet_owners/123?include=pets zu reproduzieren, vergleiche es dann mit der funktionierenden PersonResource-Anfrage und verfolge die Suche nach polymorphen Beziehungen rund um model_name. Erledigt ist es, wenn die aliased Ressource die Cat- und Dog-Beziehungen wie erwartet findet und einbindet.

Vom Indexierungsmodell aus dem Issue-Text verfasst.

Bewertung

Tech-Stack
rails, ruby
Bereich
api, backend-api-design
Issue-Typ
Bug
Schwierigkeit
4/5
Geschätzter Aufwand
3-5 Tage
Aktivitätsstatus
Veraltet
Klarheit
Größtenteils klar
Anfängerfreundlichkeit
35/100

Neue Issues direkt in Ihr Postfach

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