JSONAPI-Resources / JSONAPI-Resources/jsonapi-resources
Default fields resource option
オープン
まだ誰も着手していません。
Type: Enhancement
- 主要言語
- Ruby
- スター
- 2.3k
- フォーク
- 546
- PR マージ指標
- 30日以内にマージされた PR はありません
説明
Add an option to the resource class to specify the default fields. Would be used by the request parser if the fields are not specified. Would allow a pared down fields set as the default, while still allowing the full field set if requested.
For example:
class CommentResource < JSONAPI::Resource
attributes :body
has_one :post
has_one :author, class_name: 'Person'
has_many :tags
filters :body
default_fields [:body, :post, :author]
end
Would skip the tags relationship, unless specified in the request.
Comments?
コントリビューションガイド
このリポジトリのコントリビューションガイドは索引されていません
はじめの一歩
- issue を最後まで読み、次にプロジェクトのコントリビューションガイドを読みます。
- 着手することを issue にコメントします — 二人が同じ作業をするのを防げます。
- リポジトリをフォークし、ブランチを切って変更します。
- issue 番号を参照したプルリクエストを送ります。
調査の方向性
まず、リソースクラスのオプション処理と、issue で言及されているリクエストパーサーの場所を特定します。要求されたフィールドとリレーションがどのように選択されるかを追跡し、そのうえで、フィールドが存在しない場合にのみデフォルトリストを適用する方法を判断します。リソースでデフォルトフィールドを宣言でき、省略されたリレーションがデフォルトで除外され、明示的に要求されたフィールドが引き続き機能すれば完了です。
索引モデルが issue の本文から書いたものです。
評価
- 技術スタック
- rails, ruby
- 領域
- api, backend
- issue の種類
- 機能追加
- 難易度
- 4/5
- 見積もり時間
- 3〜5日
- 活発さ
- 停滞
- 明瞭さ
- おおむね明確
- 初心者へのやさしさ
- 35/100