Skip to content
This repository has been archived by the owner on Jul 24, 2021. It is now read-only.

paging support #941

Open
karenetheridge opened this issue Nov 8, 2019 · 0 comments
Open

paging support #941

karenetheridge opened this issue Nov 8, 2019 · 0 comments
Labels
api breaking enhancement extends current functionality on hold v3.next features, big changes for api v3.<next>

Comments

@karenetheridge
Copy link
Contributor

karenetheridge commented Nov 8, 2019

Support ?page_num=X&page_size=Y parameters for (some) GET requests that would ordinarily return a lot of content. Enforce a reasonable max page size. Possibly should allow caller to specify which column to sort on so the paging comes out as desired.

Prime candidates:

GET /user
GET /build/*/device
GET /build/*/rack

Additionally, the Accept-Range and Content-Range response headers should always be used to describe the parameters of the content (and 416 Range Not Satisfiable, when appropriate).

alternatively, use the Range header to request pages and to negotiate content size. see https://tools.ietf.org/html/rfc7233, in which case we can return 206 Partial Content instead of 200 OK responses.

@karenetheridge karenetheridge added enhancement extends current functionality api breaking v3.next features, big changes for api v3.<next> labels Nov 8, 2019
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
api breaking enhancement extends current functionality on hold v3.next features, big changes for api v3.<next>
Projects
None yet
Development

No branches or pull requests

1 participant