gr2m / gr2m/github-api-wishlist

Make REST API pagination more consisent

Đang mở
#4 0 bình luận 0 reaction 0 người được giao Xem trên GitHub
Ngôn ngữ chính
Không có dữ liệu ngôn ngữ
Star
7
Fork
1
Chỉ số merge pull request
Không có pull request nào được merge trong 30 ngày

Mô tả

note to self:

- some endpoints have namespaced pagination response (object, instead of array)
- pagination headers are not always present (not present if there is only one page), which makes it hard to recognize endpoints that do paginate

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

Mở hướng dẫn đóng góp

Hướng nghiên cứu

Bắt đầu bằng cách lập danh mục các endpoint của REST API và so sánh cấu trúc phản hồi phân trang cùng các header của chúng. Issue không nêu tên tệp, test hay entry point, vì vậy trước tiên hãy xác định các endpoint bị ảnh hưởng và hành vi nhất quán được dự kiến. Công việc được xem là hoàn tất khi định dạng phân trang và sự hiện diện của các header được xác định và nhất quán trên các endpoint bị ảnh hưởng.

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

Đánh giá

Lĩnh vực
api
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.