JSONAPI-Resources / JSONAPI-Resources/jsonapi-resources

Filter included resources or way around it

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

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

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

説明

Hi,

Is there currently a way of filtering resources that are included to our response?

ie: I want to get and include books with that response I'll just do

address/shelves?include=books

but what if I would like to filter by only available books?

ie: address/shelves/?include=books&filter[books.available]=true

books.available is just a scope in this case

or is the preffered method to do this by declaring additional relationships in the shelf resource?
like below

class ShelfResource < JSONAPI::Resource
  has_many :books
  has_many :available_books
  ...
end

If the latter, how do I exactly specify the method for finding resources for this relationship?

I've tried that already by adding

def records_for_available_books
  _model.books.available
end

to the shelf resource but I keep getting errors when doing that.

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

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

はじめの一歩

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

調査の方向性

ShelfResource の has_many :books リレーションと records_for_available_books メソッドから始め、次に include と filter[books.available] がどのように処理されるかを追跡します。報告されたエラーを再現し、リレーションの宣言と要求されたフィルタリング済みレスポンスを比較します。含める books をフィルタリングするサポートされた方法が確立されて例が動作するか、または制限事項と推奨されるリレーションの方法が文書化されれば完了です。

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

評価

技術スタック
ruby
領域
api, backend
issue の種類
機能追加
難易度
4/5
見積もり時間
3〜5日
活発さ
停滞
明瞭さ
説明が足りない
初心者へのやさしさ
35/100

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

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