JSONAPI-Resources / JSONAPI-Resources/jsonapi-resources
Issue with `fields` request params
Dieses Issue hat noch niemand übernommen.
- Vorherrschende Sprache
- Ruby
- Sterne
- 2.3k
- Forks
- 546
- PR-Merge-Kennzahlen
- Keine gemergten PRs in 30 T.
Beschreibung
As I'm playing with the Sparse Fieldsets, I encountered some issues.
With the following resources:
class UserResource < JSONAPI::Resource
has_one :status, class_name: 'UserStatus'
attributes :name, :email
end
class UserStatusResource < JSONAPI::Resource
has_one :user
attributes :foo, :bar
end
Relationships are removed from then response when using fields, so we can't link a user to his status.
/users?include=status&fields[users]=name
Association with custom class_name failed with fields.
/users?include=status&fields[users]=name&fields[user-statuses]=foo
returns:
{:errors=>
[{:title=>"Invalid resource",
:detail=>"user-statuses is not a valid resource.",
:id=>nil,
:href=>nil,
:code=>101,
:path=>nil,
:links=>nil,
:status=>"bad_request"},
{:title=>"Invalid resource",
:detail=>"user-statuses is not a valid resource.",
:id=>nil,
:href=>nil,
:code=>101,
:path=>nil,
:links=>nil,
:status=>"bad_request"}]}
Beitragsleitfaden
Für dieses Repository ist kein Beitragsleitfaden indexiert
Erste Schritte
- Lies das ganze Issue und danach den Beitragsleitfaden des Projekts.
- Schreib ins Issue, dass du es übernimmst — das erspart doppelte Arbeit.
- Forke das Repository und arbeite in einem Branch.
- Öffne einen Pull Request, der die Issue-Nummer nennt.
Rechercherichtung
Beginne mit den Beispielen für UserResource und UserStatusResource und reproduziere die beiden Requests mit include=status und den fields-Parametern. Verfolge die Verarbeitung von Sparse-Fieldsets für Relationships und den benutzerdefinierten Resource-Key class_name. Als erledigt gilt, wenn die Relationship weiterhin verknüpfbar bleibt und user-statuses ohne die gemeldeten Invalid-Resource-Fehler akzeptiert wird.
Vom Indexierungsmodell aus dem Issue-Text verfasst.
Bewertung
- Tech-Stack
- ruby
- Bereich
- api
- Issue-Typ
- Bug
- Schwierigkeit
- 4/5
- Geschätzter Aufwand
- 3-5 Tage
- Aktivitätsstatus
- Veraltet
- Klarheit
- Größtenteils klar
- Anfängerfreundlichkeit
- 35/100