Background
Several API endpoints currently return potentially large lists without any pagination. This can lead to performance and usability issues when dealing with large datasets.
Proposal
Implement pagination support for all API endpoints that return a list. This should include:
- Standard query parameters for page size and page number (e.g.,
page, limit or per_page).
- Documentation and consistent API response structure for paginated data (including total count, next/previous links or indicators as appropriate).
- Input validation for pagination parameters.
- Updates to OpenAPI/Swagger documentation to reflect changes.
Acceptance Criteria
- All list-returning endpoints accept pagination parameters and return paginated results.
- Documentation is updated to detail pagination usage for each relevant endpoint.
- Existing clients are notified of the required changes.
Benefit
Pagination will make the API scalable, improve response times, and enhance the user/developer experience.
Background
Several API endpoints currently return potentially large lists without any pagination. This can lead to performance and usability issues when dealing with large datasets.
Proposal
Implement pagination support for all API endpoints that return a list. This should include:
page,limitorper_page).Acceptance Criteria
Benefit
Pagination will make the API scalable, improve response times, and enhance the user/developer experience.