List documentation should say if the endpoint is auto-paginated
displague opened this issue · 0 comments
displague commented
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