Add pagination support to large endpoints - Githubissues

GSA / data.gov

Main repository for the data.gov service

https://data.gov

Other

590 stars 91 forks source link

Add pagination support to large endpoints #4810

Open btylerburton opened 1 month ago

btylerburton commented 1 month ago

User Story

In order to ensure adequate application performance, datagovteam wants to configure support for pagination on large API endpoints.

Acceptance Criteria

[ACs should be clearly demoable/verifiable whenever possible. Try specifying them using BDD.]

[ ] GIVEN I have an API endpoint that returns a large number of objects THEN I want to be able to paginate that response
[ ] GIVEN I have paginated an API endpoint THEN I want to modify the UI to support prev/next pages

Background

Flask-SQLAlchemy supports pagination out of the box. More here: https://blog.miguelgrinberg.com/post/the-flask-mega-tutorial-part-ix-pagination

Security Considerations (required)

None

Sketch

Refer to this doc for endpoints that should be paginated: https://docs.google.com/document/d/1XzfTrPxu-asJ_55GoeZ2UOJsie9CuCegStS28BAL_40/edit#bookmark=id.b65a2dhkc3og
Implement pagination using the SQLAlchemy paginate option
Update routes which count on those calls to support pagination
Update UI which displays those endpoints to support pagination via prev/next buttons

jbrown-xentity commented 1 month ago

Plan to use server side rendering, but possible to use client side in organization or harvest source searching.