JSONAPI-Resources / JSONAPI-Resources/jsonapi-resources
Issue with `fields` request params
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ả
As I'm playing with the Sparse Fieldsets, I encountered some issues.
With the following resources:
class UserResource < JSONAPI::Resource
has_one :status, class_name: 'UserStatus'
attributes :name, :email
end
class UserStatusResource < JSONAPI::Resource
has_one :user
attributes :foo, :bar
end
Relationships are removed from then response when using fields, so we can't link a user to his status.
/users?include=status&fields[users]=name
Association with custom class_name failed with fields.
/users?include=status&fields[users]=name&fields[user-statuses]=foo
returns:
{:errors=>
[{:title=>"Invalid resource",
:detail=>"user-statuses is not a valid resource.",
:id=>nil,
:href=>nil,
:code=>101,
:path=>nil,
:links=>nil,
:status=>"bad_request"},
{:title=>"Invalid resource",
:detail=>"user-statuses is not a valid resource.",
:id=>nil,
:href=>nil,
:code=>101,
:path=>nil,
:links=>nil,
:status=>"bad_request"}]}
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
- Đọc hết issue, rồi đọc hướng dẫn đóng góp của dự án.
- 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.
- Fork repository và làm thay đổi trên một nhánh.
- 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ụ UserResource và UserStatusResource, sau đó tái hiện hai request bằng include=status và các tham số fields. Theo dõi cách xử lý sparse fieldset cho các relationship và resource key tùy chỉnh class_name. Hoàn tất khi relationship vẫn có thể liên kết được và user-statuses được chấp nhận mà không có các lỗi invalid-resource đã báo cáo.
Do mô hình lập chỉ mục viết ra từ nội dung của issue.
Đánh giá
- Công nghệ
- ruby
- Lĩnh vực
- api
- Loại issue
- Lỗi
- Độ khó
- 4/5
- Thời gian dự kiến
- 3-5 ngày
- Mức độ hoạt động
- Đình trệ
- Độ rõ ràng
- Khá rõ ràng
- Mức phù hợp với người mới
- 35/100