Skip to content

docs(creators): totalItems/totalPages are lower bounds on ?query= search #5

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
ZacxDev wants to merge 1 commit into
base: main
Choose a base branch
from
Open

docs(creators): totalItems/totalPages are lower bounds on ?query= search #5

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 9 additions & 1 deletion site/reference/creators.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -55,12 +55,20 @@ endpoint.
- `modelCount` is only included when greater than zero; creators with no
published models are excluded from the listing entirely.
- `image` is null when the creator has no avatar.
- When a `query` is supplied, `metadata.totalItems` and `metadata.totalPages`
are **lower bounds**, not exact counts. They grow monotonically as you page
and are exact only once you reach the final page. Treat the presence of
`metadata.nextPage` as the authoritative "another page exists" signal rather
than comparing `currentPage` against `totalPages`. The unfiltered listing (no
`query`) still returns an exact `totalItems`/`totalPages`.

### Notes

- For very deep traversals, scope with `?query=` rather than paging linearly —
the listing is sorted alphabetically by username, so `query=A`, `query=B`,
... is a reliable way to walk the full set.
... is a reliable way to walk the full set. Page within each `query` by
following `metadata.nextPage` until it is absent (on the search path the total
counts are lower bounds — see the note above).

### Examples

Expand Down
Loading