mirror of
https://github.com/zulip/zulip.git
synced 2025-10-23 04:52:12 +00:00
openapi: Improve description for default_group_name
field.
This commit updates the description for `default_group_name` field in `server_supported_permission_settings` object to clearly mention that `stream_creator_or_nobody` is one of the possible values and explain its meaning.
This commit is contained in:
@@ -27975,7 +27975,18 @@ components:
|
||||
default_group_name:
|
||||
type: string
|
||||
description: |
|
||||
Name of the default group for the setting.
|
||||
Name of the default system group for the setting.
|
||||
|
||||
For some channel settings, this can also be `stream_creator_or_nobody`.
|
||||
In that case:
|
||||
|
||||
- If the channel's [`creator_id`][channel-response] is not `null`, default for the
|
||||
setting is an anonymous group with the channel creator as
|
||||
the only member.
|
||||
- If the channel's [`creator_id`][channel-response] is `null`, default for the setting
|
||||
is `role:nobody` system group.
|
||||
|
||||
[channel-response]: /api/get-stream-by-id#response
|
||||
default_for_system_groups:
|
||||
type: string
|
||||
nullable: true
|
||||
|
Reference in New Issue
Block a user