JSONAPI-Resources / JSONAPI-Resources/jsonapi-resources

More Helpful Error Messages for Relationship Type Mismatches

オープン
#807 コメント 2 件 リアクション 3 件 担当者 0 名 GitHub で見る

まだ誰も着手していません。

Type: Enhancement
主要言語
Ruby
スター
2.3k
フォーク
546
PR マージ指標
30日以内にマージされた PR はありません

説明

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.

コントリビューションガイド

このリポジトリのコントリビューションガイドは索引されていません

はじめの一歩

  1. issue を最後まで読み、次にプロジェクトのコントリビューションガイドを読みます。
  2. 着手することを issue にコメントします — 二人が同じ作業をするのを防げます。
  3. リポジトリをフォークし、ブランチを切って変更します。
  4. issue 番号を参照したプルリクエストを送ります。

調査の方向性

この issue ではファイル、テスト、エントリポイントが指定されていません。まず、無効な relationship resource type を処理するエラーパスを特定し、関連するエラーレスポンスのテストを確認してください。Mismatch レスポンスで有効な resource type が示され、開発環境と本番環境の動作の違いが解決されれば完了です。

索引モデルが issue の本文から書いたものです。

評価

技術スタック
ruby
領域
api, backend-api-design
issue の種類
機能追加
難易度
4/5
見積もり時間
3〜5日
活発さ
停滞
明瞭さ
おおむね明確
初心者へのやさしさ
25/100

新しい issue をメールで受け取る

初心者向けの GitHub issue を短くまとめたダイジェスト。