liz/PluralKit
liz/PluralKit
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

feat(docs): document pagination requirement for /systems/:ref/switches endpoint

Browse Source
This commit is contained in:
spiral 2021-11-17 09:53:17 -05:00
parent b4b83f2c94
commit d72537eded
No known key found for this signature in database
GPG Key ID: A6059F0CA0E1BD31
1 changed files with 4 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

5
docs/content/api/endpoints.md
View File

@ -213,7 +213,10 @@ Query String Parameters
|key|type|description| |key|type|description|
|---|---|---| |---|---|---|
|before|timestamp|date to get latest switch from| |before|timestamp|date to get latest switch from|
|limit|int|number of switches to get| |limit|int|number of switches to get (defaults to 100)||
::: warning
This endpoint returns at most 100 switches. To get more switches, make multiple requests using the `before` parameter for pagination.
:::
Returns a [switch object](/api/models#switch-model) containing a list of IDs. Returns a [switch object](/api/models#switch-model) containing a list of IDs.