paulmataruso/zulip
1
0
Fork 0
mirror of https://github.com/zulip/zulip.git synced 2025-11-04 05:53:43 +00:00
Code Issues Packages Projects Releases Wiki Activity

api-docs: Fix incorrect field names for group-setting value objects.

Browse Source 
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.
This commit is contained in:
Sahil Batra
2025-08-29 12:07:03 +05:30
committed by Tim Abbott
parent b4edfb4a19
commit aae639a8a0
1 changed files with 4 additions and 4 deletions
Download Patch File Download Diff File Expand all files Collapse all files

8
api_docs/group-setting-values.md
View File

@@ -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