From aae639a8a0b5ad6d2cb5db8a32f67a44b3aa3e66 Mon Sep 17 00:00:00 2001 From: Sahil Batra Date: Fri, 29 Aug 2025 12:07:03 +0530 Subject: [PATCH] api-docs: Fix incorrect field names for group-setting value objects. Documentation for group setting values at /api/group-setting-values incorrectly mentioned obejct fields as 'direct_member_ids' and 'direct_subgroup_ids' when they actually are 'direct_members' and 'direct_subgroups' from the start. --- api_docs/group-setting-values.md | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/api_docs/group-setting-values.md b/api_docs/group-setting-values.md index b308e70920..0ad1d21f3a 100644 --- a/api_docs/group-setting-values.md +++ b/api_docs/group-setting-values.md @@ -21,8 +21,8 @@ value**, which can take two forms: - An integer user group ID, which can be either a named user group visible in the UI or a [role-based system group](#system-groups). -- An object with fields `direct_member_ids`, containing a list of - integer user IDs, and `direct_subgroup_ids`, containing a list of +- An object with fields `direct_members`, containing a list of + integer user IDs, and `direct_subgroups`, containing a list of integer group IDs. The setting's value is the union of the identified collection of users and groups. @@ -31,8 +31,8 @@ anonymous group. They function very much like a named user group object, and remove the naming and UI overhead involved in creating a visible user group just to store the value of a single setting. -The server will canonicalize an object with an empty `direct_member_ids` -list and a `direct_subgroup_ids` list that contains just a single group +The server will canonicalize an object with an empty `direct_members` +list and a `direct_subgroups` list that contains just a single group ID to the integer format. ## System groups