Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

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
Member

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 join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant