mirror of
https://github.com/zulip/zulip.git
synced 2025-11-10 00:46:03 +00:00
api-docs: Clean up descriptions of can_mention_group user group setting.
This commit is contained in:
Lauryn Menard
committed by
Tim Abbott
Tim Abbott
parent
03f81eef07
commit
f13efbd6df
@@ -3176,19 +3176,24 @@ paths:
|
|||||||
allOf:
|
allOf:
|
||||||
- $ref: "#/components/schemas/GroupSettingValue"
|
- $ref: "#/components/schemas/GroupSettingValue"
|
||||||
- description: |
|
- description: |
|
||||||
Either the ID of a named user group that has permission
|
A [group-setting value][setting-values] defining the set of users who
|
||||||
to mention the group, or an object describing the set of
|
have permission to [mention this user group][mentions]. Only present
|
||||||
users and groups who have permission mention the group.
|
if this user group permission setting changed.
|
||||||
|
|
||||||
**Changes**: Before Zulip 9.0 (feature level 258), the
|
**Changes**: Before Zulip 9.0 (feature level 258), this setting was
|
||||||
`can_mention_group` field was always an integer.
|
always the integer form of a [group-setting value][setting-values].
|
||||||
|
|
||||||
Before Zulip 8.0 (feature level 198),
|
Before Zulip 8.0 (feature level 198), this setting was named
|
||||||
the `can_mention_group` setting
|
`can_mention_group_id`.
|
||||||
was named `can_mention_group_id`.
|
|
||||||
|
|
||||||
New in Zulip 8.0 (feature level 191). Previously, groups
|
New in Zulip 8.0 (feature level 191). Previously, groups could be
|
||||||
could be mentioned if and only if they were not system groups.
|
mentioned only if they were not [system groups][system-groups].
|
||||||
|
|
||||||
|
Will be one of the following:
|
||||||
|
|
||||||
|
[setting-values]: /api/group-setting-values
|
||||||
|
[system-groups]: /api/group-setting-values#system-groups
|
||||||
|
[mentions]: /help/mention-a-user-or-group
|
||||||
example:
|
example:
|
||||||
{
|
{
|
||||||
"type": "user_group",
|
"type": "user_group",
|
||||||
@@ -19006,20 +19011,24 @@ paths:
|
|||||||
can_mention_group:
|
can_mention_group:
|
||||||
allOf:
|
allOf:
|
||||||
- description: |
|
- description: |
|
||||||
A [group-setting value](/api/group-setting-values) defining the set
|
A [group-setting value][setting-values] defining the set of users who
|
||||||
of users who have permission to mention the new group.
|
have permission to [mention this user group][mentions].
|
||||||
|
|
||||||
This setting cannot be set to `"role:internet"` and
|
This setting cannot be set to `"role:internet"` and `"role:owners"`
|
||||||
`"role:owners"` system groups.
|
[system groups][system-groups].
|
||||||
|
|
||||||
**Changes**: Before Zulip 9.0 (feature level 258), the
|
Before Zulip 9.0 (feature level 258), this parameter could only be the
|
||||||
`can_mention_group` setting could only be set to an integer.
|
integer form of a [group-setting value][setting-values].
|
||||||
|
|
||||||
Before Zulip 8.0 (feature level 198),
|
Before Zulip 8.0 (feature level 198), this parameter was named
|
||||||
the `can_mention_group` setting was named `can_mention_group_id`.
|
`can_mention_group_id`.
|
||||||
|
|
||||||
New in Zulip 8.0 (feature level 191). Previously, groups
|
New in Zulip 8.0 (feature level 191). Previously, groups could be
|
||||||
could be mentioned if and only if they were not system groups.
|
mentioned only if they were not [system groups][system-groups].
|
||||||
|
|
||||||
|
[setting-values]: /api/group-setting-values
|
||||||
|
[system-groups]: /api/group-setting-values#system-groups
|
||||||
|
[mentions]: /help/mention-a-user-or-group
|
||||||
- $ref: "#/components/schemas/GroupSettingValue"
|
- $ref: "#/components/schemas/GroupSettingValue"
|
||||||
example: 11
|
example: 11
|
||||||
required:
|
required:
|
||||||
@@ -19159,24 +19168,30 @@ paths:
|
|||||||
example: The marketing team.
|
example: The marketing team.
|
||||||
can_mention_group:
|
can_mention_group:
|
||||||
description: |
|
description: |
|
||||||
The set of users who have permission to mention
|
The set of users who have permission to [mention this group][mentions],
|
||||||
this group, expressed as an [update to a
|
expressed as an [update to a group-setting value][update-group-setting].
|
||||||
group-setting value](/api/group-setting-values#updating-group-setting-values).
|
|
||||||
|
|
||||||
This setting cannot be set to `"role:internet"` and `"role:owners"`
|
This setting cannot be set to `"role:internet"` and `"role:owners"`
|
||||||
system groups.
|
[system groups][system-groups].
|
||||||
|
|
||||||
**Changes**: In Zulip 9.0 (feature level 260), this was updated
|
**Changes**: In Zulip 9.0 (feature level 260), this parameter was
|
||||||
to only accept an object with `old` and `new` fields.
|
updated to only accept an object with the `old` and `new` fields
|
||||||
|
described below. Prior to this feature level, this parameter could be
|
||||||
|
either of the two forms of a [group-setting value][setting-values].
|
||||||
|
|
||||||
Before Zulip 9.0 (feature level 258), the
|
Before Zulip 9.0 (feature level 258), this parameter could only be the
|
||||||
`can_mention_group` field was always an integer.
|
integer form of a [group-setting value][setting-values].
|
||||||
|
|
||||||
Before Zulip 8.0 (feature level 198),
|
Before Zulip 8.0 (feature level 198), this parameter was named
|
||||||
the `can_mention_group` setting was named `can_mention_group_id`.
|
`can_mention_group_id`.
|
||||||
|
|
||||||
New in Zulip 8.0 (feature level 191). Previously, groups
|
New in Zulip 8.0 (feature level 191). Previously, groups could be
|
||||||
could be mentioned if and only if they were not system groups.
|
mentioned only if they were not [system groups][system-groups].
|
||||||
|
|
||||||
|
[mentions]: /help/mention-a-user-or-group
|
||||||
|
[update-group-setting]: /api/group-setting-values#updating-group-setting-values
|
||||||
|
[system-groups]: /api/group-setting-values#system-groups
|
||||||
|
[setting-values]: /api/group-setting-values
|
||||||
type: object
|
type: object
|
||||||
additionalProperties: false
|
additionalProperties: false
|
||||||
properties:
|
properties:
|
||||||
@@ -19321,17 +19336,23 @@ paths:
|
|||||||
allOf:
|
allOf:
|
||||||
- $ref: "#/components/schemas/GroupSettingValue"
|
- $ref: "#/components/schemas/GroupSettingValue"
|
||||||
- description: |
|
- description: |
|
||||||
A [group-setting value](/api/group-setting-values) defining the set
|
A [group-setting value][setting-values] defining the set of users who
|
||||||
of users who have permission to mention the new group.
|
have permission to [mention this user group][mentions].
|
||||||
|
|
||||||
**Changes**: Before Zulip 9.0 (feature level 258), the
|
**Changes**: Before Zulip 9.0 (feature level 258), this setting was
|
||||||
`can_mention_group` field was always an integer.
|
always the integer form of a [group-setting value][setting-values].
|
||||||
|
|
||||||
Before Zulip 8.0 (feature level 198),
|
Before Zulip 8.0 (feature level 198), this setting was named
|
||||||
the `can_mention_group` setting was named `can_mention_group_id`.
|
`can_mention_group_id`.
|
||||||
|
|
||||||
New in Zulip 8.0 (feature level 191). Previously, groups
|
New in Zulip 8.0 (feature level 191). Previously, groups could be
|
||||||
could be mentioned if and only if they were not system groups.
|
mentioned only if they were not [system groups][system-groups].
|
||||||
|
|
||||||
|
Will be one of the following:
|
||||||
|
|
||||||
|
[setting-values]: /api/group-setting-values
|
||||||
|
[system-groups]: /api/group-setting-values#system-groups
|
||||||
|
[mentions]: /help/mention-a-user-or-group
|
||||||
description: |
|
description: |
|
||||||
A list of `user_group` objects.
|
A list of `user_group` objects.
|
||||||
example:
|
example:
|
||||||
@@ -20504,17 +20525,23 @@ components:
|
|||||||
allOf:
|
allOf:
|
||||||
- $ref: "#/components/schemas/GroupSettingValue"
|
- $ref: "#/components/schemas/GroupSettingValue"
|
||||||
- description: |
|
- description: |
|
||||||
A [group-setting value](/api/group-setting-values) defining the set
|
A [group-setting value][setting-values] defining the set of users who
|
||||||
of users who have permission to mention the new group.
|
have permission to [mention this user group][mentions].
|
||||||
|
|
||||||
**Changes**: Before Zulip 9.0 (feature level 258), the
|
**Changes**: Before Zulip 9.0 (feature level 258), this setting was
|
||||||
`can_mention_group` field was always an integer.
|
always the integer form of a [group-setting value][setting-values].
|
||||||
|
|
||||||
Before Zulip 8.0 (feature level 198),
|
Before Zulip 8.0 (feature level 198), this setting was named
|
||||||
the `can_mention_group` setting was named `can_mention_group_id`.
|
`can_mention_group_id`.
|
||||||
|
|
||||||
New in Zulip 8.0 (feature level 191). Previously, groups
|
New in Zulip 8.0 (feature level 191). Previously, groups could be
|
||||||
could be mentioned if and only if they were not system groups.
|
mentioned only if they were not [system groups][system-groups].
|
||||||
|
|
||||||
|
Will be one of the following:
|
||||||
|
|
||||||
|
[setting-values]: /api/group-setting-values
|
||||||
|
[system-groups]: /api/group-setting-values#system-groups
|
||||||
|
[mentions]: /help/mention-a-user-or-group
|
||||||
GroupSettingValue:
|
GroupSettingValue:
|
||||||
oneOf:
|
oneOf:
|
||||||
- type: object
|
- type: object
|
||||||
@@ -20532,6 +20559,8 @@ components:
|
|||||||
type: array
|
type: array
|
||||||
items:
|
items:
|
||||||
type: integer
|
type: integer
|
||||||
|
description: |
|
||||||
|
An object with these fields:
|
||||||
- type: integer
|
- type: integer
|
||||||
description: |
|
description: |
|
||||||
The ID of the [user group](/help/user-groups) with this permission.
|
The ID of the [user group](/help/user-groups) with this permission.
|
||||||
|
|||||||
Reference in New Issue
Block a user