Skip to content

Per 10309 add pagination to list endpoints#802

Merged
liam-lloyd merged 4 commits into
mainfrom
per-10309_add_pagination_to_list_endpoints
Jul 17, 2026
Merged

Per 10309 add pagination to list endpoints#802
liam-lloyd merged 4 commits into
mainfrom
per-10309_add_pagination_to_list_endpoints

Conversation

@liam-lloyd

@liam-lloyd liam-lloyd commented Jul 9, 2026

Copy link
Copy Markdown
Member

This is built on top of #801, which fixes some smaller API standard violations. Only the commits adding pagination to various endpoints are unique to this PR.

@liam-lloyd
liam-lloyd force-pushed the per-10309_add_pagination_to_list_endpoints branch from 4234c82 to 897dac7 Compare July 9, 2026 20:47
@codecov

codecov Bot commented Jul 9, 2026

Copy link
Copy Markdown

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 98.30%. Comparing base (f4ebf7f) to head (24c0a19).

Additional details and impacted files
@@            Coverage Diff             @@
##             main     #802      +/-   ##
==========================================
+ Coverage   98.22%   98.30%   +0.08%     
==========================================
  Files          93       93              
  Lines        2364     2482     +118     
  Branches      438      462      +24     
==========================================
+ Hits         2322     2440     +118     
  Misses         42       42              
Flag Coverage Δ
api 98.30% <ø> (+0.08%) ⬆️

Flags with carried forward coverage won't be shown. Click here to find out more.

☔ View full report in Codecov by Harness.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.
  • 📦 JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.

@cecilia-donnelly cecilia-donnelly left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This looks good to me! Thanks @liam-lloyd .

Our API design standard says that when endpoints return multiple
objects, the results should be paginated. This commit updates the GET
/records endpoint to make it compliant with that standard. It leaves
current behavior in place for the deprecated GET /record path, because
clients are actively using this path. Once clients switch to the
now-paginated GET /records, we can remove the GET /record path.
Our API design standard says that when endpoints return multiple
objects, the results should be paginated. This commit updates the GET
/folders endpoint to make it compliant with that standard. It leaves
current behavior in place for the deprecated GET /folder path, because
clients are actively using this path. Once clients switch to the
now-paginated GET /folders, we can remove the GET /folder path.
 Our API design principles say that endpoints that return lists of
 objects should paginate those lists. Currently,  GET
 /archives/:archiveId/folders/shared returns an unpaginated response.
 This commit paginates it. No client currently uses this endpoint, so
 this should be a safe change to make.
Our API design principles say that endpoints that return lists of
objects should be paginated. This commit updates GET /share-links to
comply with that. Unlike other paginated endpoints, makes pageSize
optional for backward compatibility. pageSize defaults to 10, which is
greater than the number of share links requested in any existing call to
this endpoint.
@liam-lloyd
liam-lloyd force-pushed the per-10309_add_pagination_to_list_endpoints branch from 897dac7 to 24c0a19 Compare July 17, 2026 20:08
@liam-lloyd
liam-lloyd merged commit 0667e8c into main Jul 17, 2026
35 checks passed
@liam-lloyd
liam-lloyd deleted the per-10309_add_pagination_to_list_endpoints branch July 17, 2026 20:54
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

Successfully merging this pull request may close these issues.

2 participants