feat(api-keys): add opaque-cursor pagination to the listing endpoint - #411
Merged
mikewheeleer merged 2 commits intoJul 29, 2026
Merged
Conversation
The GET /api/v1/api-keys handler inlined the same limit/offset parsing and slicing preamble duplicated in the webhooks list handler. Extracted it into applyOffsetPage() in src/listPagination.ts as a single reusable entry point; behavior is unchanged (same defaults, same response shape).
Adds a generic paginateByCursor() helper (src/cursorPagination.ts) and an applyListPage() wrapper that layers opt-in ?cursor= paging on top of the existing offset/limit contract: passing cursor takes priority over offset, and both modes now report a stable nextCursor so existing offset-based clients can migrate without a contract change. Malformed or expired cursors return 400 invalid_request. Item shape and existing offset behavior are unchanged.
This was referenced Jul 28, 2026
Contributor
|
@thlpkee20-wq clean implementation, merging with thanks 🙌 |
1 similar comment
Contributor
|
@thlpkee20-wq clean implementation, merging with thanks 🙌 |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Closes #382
Adds a generic
paginateByCursor()helper (src/cursorPagination.ts)and an
applyListPage()wrapper that layers opt-in?cursor=paging ontop of the existing offset/limit contract on
GET /api/v1/api-keys:passing
cursortakes priority overoffset, and both modes now reporta stable
nextCursorso existing offset-based clients can migratewithout a contract change. A malformed or expired cursor returns
400 invalid_request. Item shape is unchanged.Test plan
npm run buildnpm run lintnpm test— targeted run oflist-pagination.test.js,apikey-recognition.test.js,routes/operational.test.js: 13/13passing.
Note
I don't have push access to this repo (fork-only), so I can't target a
non-
mainbase branch for a true stacked PR. This branch is stacked on#410 (
refactor(api-keys): extract shared offset-pagination helper) —until that merges, this diff will include its commit too. The
cursor-pagination-specific change is
src/cursorPagination.ts(new) plusthe
applyListPageaddition insrc/listPagination.tsand the updatedGET /api/v1/api-keyshandler insrc/routes/apiKeys.ts.