Skip to content
This repository has been archived by the owner on Jun 21, 2024. It is now read-only.

List documentation should say if the endpoint is auto-paginated #268

Open
displague opened this issue Apr 20, 2021 · 0 comments
Open

List documentation should say if the endpoint is auto-paginated #268

displague opened this issue Apr 20, 2021 · 0 comments

Comments

@displague
Copy link
Contributor

It should be clear from the function documentation if a list endpoint supports pagination or not. Because paginated end-points are auto-paginated by default, we can add "This listing will be auto-paginated. Use ListOptions{Page:x} to change that behavior." For end-points that do not support Pagination we can add "This listing does not support pagination."

It may have been more idea for a PaginatedListOptions to provide the paginated fields. We couldn't take that approach in #211 for backward compatibility concerns.

Related to #266

Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant