From dfa74272adbf3206b1ef693fc00bd5924f9aca89 Mon Sep 17 00:00:00 2001 From: "David B. Maier" Date: Tue, 27 Aug 2024 22:35:01 +0200 Subject: [PATCH] Add notes to live club endpoints with limits --- docs/live/clubs/campaigns.md | 1 + docs/live/clubs/clubs.md | 1 + docs/live/clubs/competitions.md | 6 ++++++ docs/live/clubs/rooms.md | 1 + 4 files changed, 9 insertions(+) diff --git a/docs/live/clubs/campaigns.md b/docs/live/clubs/campaigns.md index b9532de..8e6bc6d 100644 --- a/docs/live/clubs/campaigns.md +++ b/docs/live/clubs/campaigns.md @@ -31,6 +31,7 @@ Gets a list of club campaigns. **Remarks**: - As of 2024-01-17, this endpoint's response links to `.dds` media files by default, while several scaled `.png` versions are available using separate fields (see example below for reference). +- This endpoint does not return all available club campaigns. When excluding the `name` parameter, it returns all verified clubs' campaigns - otherwise the response is limited to 200 campaigns. --- diff --git a/docs/live/clubs/clubs.md b/docs/live/clubs/clubs.md index ecc11bc..d5811e3 100644 --- a/docs/live/clubs/clubs.md +++ b/docs/live/clubs/clubs.md @@ -31,6 +31,7 @@ Gets a list of clubs. **Remarks**: - As of 2024-01-17, this endpoint's response links to `.dds` media files by default, while several scaled `.png`/`.jpg` versions are available using separate fields (see example below for reference). +- This endpoint does not return all available clubs. When excluding the `name` parameter, it returns all verified clubs - otherwise the response is limited to 200 clubs. --- diff --git a/docs/live/clubs/competitions.md b/docs/live/clubs/competitions.md index f7afab0..87ef976 100644 --- a/docs/live/clubs/competitions.md +++ b/docs/live/clubs/competitions.md @@ -28,6 +28,12 @@ Gets a list of club competitions. --- +**Remarks**: + +- This endpoint does not return all available club competitions. When excluding the `name` parameter, it returns all verified clubs' competitions - otherwise the response is limited to 200 competitions. + +--- + **Example request**: ```plain diff --git a/docs/live/clubs/rooms.md b/docs/live/clubs/rooms.md index 39e3e89..d23f9a6 100644 --- a/docs/live/clubs/rooms.md +++ b/docs/live/clubs/rooms.md @@ -31,6 +31,7 @@ Gets a list of club rooms. **Remarks**: - As of 2024-01-17, this endpoint's response links to `.dds` media files by default, while several scaled `.png` versions are available using separate fields (see example below for reference). +- This endpoint does not return all available club rooms. When excluding the `name` parameter, it returns all verified clubs' rooms - otherwise the response is limited to 200 rooms. ---