From 15801eb4fe2d47acd0d4eef9c08947811d03de61 Mon Sep 17 00:00:00 2001 From: Ezio Mariani Date: Fri, 27 Sep 2024 20:35:07 -0600 Subject: [PATCH 1/2] Update activities.md remark on `active` param --- docs/live/clubs/activities.md | 1 + 1 file changed, 1 insertion(+) diff --git a/docs/live/clubs/activities.md b/docs/live/clubs/activities.md index 50bf0e9..8988029 100644 --- a/docs/live/clubs/activities.md +++ b/docs/live/clubs/activities.md @@ -36,6 +36,7 @@ Gets a list of club activities, including news, rooms, campaigns and others. **Remarks**: - For clubs you are not an admin of, `active` needs to be set to `true` because only admins are allowed to see disabled activities. Otherwise you'll get an error complaining that you're not a member/admin of the club. +- If `active` is set to `false`, you will only see disabled activities. If you would like to see all enabled and disabled activites for clubs you are an admin of, you will need to send at least 2 requests. - 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). --- From 77e04bf5df0d6093095476769442f03d8de6f35c Mon Sep 17 00:00:00 2001 From: "David B. Maier" Date: Sat, 28 Sep 2024 13:40:13 +0200 Subject: [PATCH 2/2] Update active parameter and remarks --- docs/live/clubs/activities.md | 7 +++---- 1 file changed, 3 insertions(+), 4 deletions(-) diff --git a/docs/live/clubs/activities.md b/docs/live/clubs/activities.md index 8988029..6fe57a8 100644 --- a/docs/live/clubs/activities.md +++ b/docs/live/clubs/activities.md @@ -25,8 +25,8 @@ parameters: required: true - name: active type: Boolean - description: Whether to only include currently active entries - required: true + description: Optional filter for enabled/disabled activities + required: false --- Gets a list of club activities, including news, rooms, campaigns and others. @@ -35,8 +35,7 @@ Gets a list of club activities, including news, rooms, campaigns and others. **Remarks**: -- For clubs you are not an admin of, `active` needs to be set to `true` because only admins are allowed to see disabled activities. Otherwise you'll get an error complaining that you're not a member/admin of the club. -- If `active` is set to `false`, you will only see disabled activities. If you would like to see all enabled and disabled activites for clubs you are an admin of, you will need to send at least 2 requests. +- Omitting the `active` parameter implicitly requests both enabled and disabled activities. For clubs you are not an admin of, `active` needs to be explicitly set to `true` because only admins are allowed to see disabled activities - otherwise you'll get an error complaining that you're not a member/admin of the club. - 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). ---