ModernLeft/athena-docs
Watch
4
0
Fork
You've already forked athena-docs
 1
Code Issues 4 Pull requests 1 Activity Actions

docs(api): document the list-endpoint pagination envelope #13

Open
gravityfargo wants to merge 1 commit from docs/api-pagination into main
pull from: docs/api-pagination
merge into: ModernLeft:main
Conversation 0 Commits 1 Files changed 1 +59
gravityfargo commented 2026-07-30 02:12:19 +00:00
Owner
Copy link

Companion to ModernLeft/athena-api#366, which replaces every bare-array list response with a Page envelope.

Adds a Pagination section to docs/development/api.md covering:

  • the envelope and what each field means, including that total is counted through the request's own filters and so can never disagree with the page
  • the 25 default and 100 cap, and the 422 above it
  • limit=0 as the count-only form
  • the stable-ordering guarantee (every list query ends in a unique key)
  • that visibility is applied in SQL, so an anonymous caller asking for 25 rows gets 25 visible rows
  • the full table of paginated routes
  • the removals: 13 /stats/ routes, /itemset/all/, /user/all/, and the user:list role change from SUPERVISOR to RESEARCHER

Only docs/development/api.md is touched; other in-flight edits in the working tree are left alone.

Companion to ModernLeft/athena-api#366, which replaces every bare-array list response with a `Page` envelope. Adds a **Pagination** section to `docs/development/api.md` covering: - the envelope and what each field means, including that `total` is counted through the request's own filters and so can never disagree with the page - the 25 default and 100 cap, and the 422 above it - `limit=0` as the count-only form - the stable-ordering guarantee (every list query ends in a unique key) - that visibility is applied in SQL, so an anonymous caller asking for 25 rows gets 25 visible rows - the full table of paginated routes - the removals: 13 `/stats/` routes, `/itemset/all/`, `/user/all/`, and the `user:list` role change from `SUPERVISOR` to `RESEARCHER` Only `docs/development/api.md` is touched; other in-flight edits in the working tree are left alone.
This pull request can be merged automatically.
This branch is out-of-date with the base branch
You are not authorized to merge this pull request.
View command line instructions

Checkout

From your project repository, check out a new branch and test the changes.
git fetch -u origin docs/api-pagination:docs/api-pagination
git switch docs/api-pagination

Merge

Merge the changes and update on Forgejo.
git switch main
git merge --no-ff docs/api-pagination
git switch docs/api-pagination
git rebase main
git switch main
git merge --ff-only docs/api-pagination
git switch docs/api-pagination
git rebase main
git switch main
git merge --no-ff docs/api-pagination
git switch main
git merge --squash docs/api-pagination
git switch main
git merge --ff-only docs/api-pagination
git switch main
git merge docs/api-pagination
git push origin main
Sign in to join this conversation.
Reviewers
No reviewers
Labels
Clear labels
No items
No labels
Milestone
Clear milestone
No items
No milestone
Assignees
Clear assignees
No assignees
1 participant
Notifications
Due date
The due date is invalid or out of range. Please use the format "yyyy-mm-dd".

No due date set.

Dependencies

No dependencies set

Reference
ModernLeft/athena-docs!13
No description provided.