JSONAPI-Resources / JSONAPI-Resources/jsonapi-resources

More Helpful Error Messages for Relationship Type Mismatches

Offen
#807 2 Kommentare 3 Reaktionen 0 zugewiesene Personen Auf GitHub ansehen

Dieses Issue hat noch niemand übernommen.

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

Beschreibung

I encountered the following error today: "{"errors":[{"title":"Type Mismatch","detail":"category is not a valid type for this operation.","code":"116","status":"400"}]}". My Ingredient resources has a belongs-to relationship to Category. Eventually through Dan Gebhardt's help I came to realize that I should have been using the plural name of the resource in my request.

It'd be nice to have a more helpful error message when such an error occurs. Imagine my error message also included a list of valid types, e.g. "Valid types include 'categories', 'cars', 'sith-lords'." Perhaps this would only apply in dev mode, though it may not hurt in prod too.

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

Das Issue nennt keine Datei, keinen Test und keinen Einstiegspunkt. Beginne damit, den Fehlerpfad zu finden, der ungültige Relationship-Ressourcentypen behandelt, und prüfe die zugehörigen Tests für Fehlerantworten. Als erledigt gilt die Aufgabe, wenn die Mismatch-Antwort gültige Ressourcentypen angibt und das Verhalten zwischen Entwicklungs- und Produktionsumgebung geklärt ist.

Vom Indexierungsmodell aus dem Issue-Text verfasst.

Bewertung

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

Neue Issues direkt in Ihr Postfach

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