From d72537ededd48f92c36da9d1716596aad37c3290 Mon Sep 17 00:00:00 2001 From: spiral Date: Wed, 17 Nov 2021 09:53:17 -0500 Subject: [PATCH] feat(docs): document pagination requirement for /systems/:ref/switches endpoint --- docs/content/api/endpoints.md | 5 ++++- 1 file changed, 4 insertions(+), 1 deletion(-) diff --git a/docs/content/api/endpoints.md b/docs/content/api/endpoints.md index 3b86628f..f8787f8e 100644 --- a/docs/content/api/endpoints.md +++ b/docs/content/api/endpoints.md @@ -213,7 +213,10 @@ Query String Parameters |key|type|description| |---|---|---| |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.