Skip to content

Commit

Permalink
Add notes to live club endpoints with limits
Browse files Browse the repository at this point in the history
  • Loading branch information
davidbmaier committed Aug 27, 2024
1 parent 69920d2 commit dfa7427
Show file tree
Hide file tree
Showing 4 changed files with 9 additions and 0 deletions.
1 change: 1 addition & 0 deletions docs/live/clubs/campaigns.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.

---

Expand Down
1 change: 1 addition & 0 deletions docs/live/clubs/clubs.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.

---

Expand Down
6 changes: 6 additions & 0 deletions docs/live/clubs/competitions.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
1 change: 1 addition & 0 deletions docs/live/clubs/rooms.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.

---

Expand Down

0 comments on commit dfa7427

Please sign in to comment.