JSONAPI-Resources / JSONAPI-Resources/jsonapi-resources

Filtering included resources

Đang mở
#314 4 bình luận 9 reaction 0 người được giao Xem trên GitHub

Chưa có ai nhận issue này.

Ngôn ngữ chính
Ruby
Star
2.3k
Fork
546
Chỉ số merge pull request
Không có pull request nào được merge trong 30 ngày

Mô tả

We have a use-case where it would be useful to apply filters to the included resources.

Dummy example:

class UserResource < JSONAPI::Resource
  has_many :socks
  has_many :shoes
end
class SockResource < JSONAPI::Resource
  has_one :user
  filter :in_use
end
class ShoeResource < JSONAPI::Resource
  has_one :user
  filter :in_use
end

Individually, one can filter the shoes and socks
/shoes?filter[in_use]=true
/socks?filter[in_use]=true

I was wondering if it would be possible to filter the shoes and socks when included with the User?

e.g. To get the user, and the shoes and socks he currently has in use, something like:

/users/1?include=shoes,socks&filter[shoes][in_use]=true&filter[socks][in_use]=true

Is this in the scope of jsonapi-resources? or would it be best to find a custom approach?

Hướng dẫn đóng góp

Chưa lập chỉ mục được hướng dẫn đóng góp cho kho mã nguồn này

Bắt đầu từ đâu

  1. Đọc hết issue, rồi đọc hướng dẫn đóng góp của dự án.
  2. Bình luận trên issue rằng bạn sẽ nhận — tránh hai người làm cùng một việc.
  3. Fork repository và làm thay đổi trên một nhánh.
  4. Mở pull request có tham chiếu số hiệu của issue.

Hướng nghiên cứu

Bắt đầu với các ví dụ về UserResource, SockResource và ShoeResource, đồng thời xác minh cách các tham số truy vấn include và filter được hiển thị hiện đang được diễn giải. Xác định xem việc lọc các resource được include có được hỗ trợ hay không; được xem là hoàn thành khi có hành vi được hỗ trợ và được lập tài liệu kèm coverage, hoặc khi có kết luận rõ ràng rằng cần một cách tiếp cận tùy chỉnh.

Do mô hình lập chỉ mục viết ra từ nội dung của issue.

Đánh giá

Công nghệ
rails, ruby
Lĩnh vực
api, backend
Loại issue
Tính năng
Độ khó
5/5
Thời gian dự kiến
Hơn một tuần
Mức độ hoạt động
Đình trệ
Độ rõ ràng
Cần làm rõ
Mức phù hợp với người mới
25/100

Nhận issue mới trong hộp thư của bạn

Bản tóm tắt ngắn những issue GitHub phù hợp với người mới.