starred/netbox
1
0
Fork 0
mirror of https://github.com/netbox-community/netbox.git synced 2026-04-26 18:58:54 +02:00
Code Issues 273 Packages Projects Releases 10 Wiki Activity

Fixes #21935: Document MAX_PAGE_SIZE effect on GraphQL (#21940)

Browse Source
This commit is contained in:
Grische
2026-04-20 13:01:48 +02:00
committed by GitHub
parent 74dab1fba0
commit 26c6c59797
3 changed files with 14 additions and 4 deletions
Download Patch File Download Diff File Expand all files Collapse all files

8
docs/integrations/graphql-api.md
View File

@@ -141,7 +141,13 @@ To ensure consistent ordering, objects will always be ordered by their primary k
!!! note "Cursor-based pagination was introduced in NetBox v4.5.2."
Both pagination strategies support passing an optional `limit` parameter. In both approaches, this specifies the maximum number of objects to include in the response. If no limit is specified, a default value of 100 is used.
Both pagination strategies support an optional `limit` parameter specifying the maximum number of objects to include in the response. The [`MAX_PAGE_SIZE`](../configuration/miscellaneous.md#max_page_size) configuration parameter (default `1000`) sets a hard ceiling on this value; if no limit is specified, up to `MAX_PAGE_SIZE` records are returned.
When `MAX_PAGE_SIZE` is set to `0` or `None`:
* Omitting the `pagination` argument entirely returns all matching records.
* Supplying `pagination` without a `limit` returns up to Strawberry Django's default of 100 records.
* Supplying `pagination: {limit: 0}` returns _zero_ records — the opposite of the REST API's `?limit=0` semantics.
### Offset Pagination