Mirror
/
zulip
mirror of https://github.com/zulip/zulip.git
1
0
Fork 0
Code Issues Projects Releases Wiki Activity

api-docs: Revisions for feature level 161 changes. 

Revises the API changelog entry for feature level 161 to document
the changes to `DELETE /users/me/subscriptions` and to explain
more clearly what the new `can_remove_subscribers_group_id`
parameter does.

Updates the feature level 161 changes notes and related descriptions
to include links and also more clearly explain the updates.

Also, updates the `GET /user_groups` example to better reflect what
is returned for system groups since this is now referenced in the
`can_remove_subscribers_group_id` parameter description.

The original API feature level 161 API documentation changes were
made in commit c3759814be and commit 73f11853ec.
This commit is contained in:
Lauryn Menard 2023-05-31 14:03:52 +02:00 committed by Tim Abbott
parent b0b3230917
commit bca7683f58
2 changed files with 46 additions and 28 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

17
api_docs/changelog.md
View File

@ -258,13 +258,16 @@ format used by the Zulip server that they are interacting with.
**Feature level 161** **Feature level 161**
* [`PATCH /streams/{stream_id}`](/api/update-stream): Added * [`POST /users/me/subscriptions`](/api/subscribe),
`can_remove_subscribers_group_id` parameter to support [`PATCH /streams/{stream_id}`](/api/update-stream): Added
changing `can_remove_subscribers_group` setting. `can_remove_subscribers_group_id` parameter to support setting and
* [`POST /users/me/subscriptions`](/api/subscribe): Added changing the user group whose members can remove other subscribers
`can_remove_subscribers_group_id` parameter to set from the specified stream.
`can_remove_subscribers_group` setting while creating * [`DELETE /users/me/subscriptions`](/api/unsubscribe): Expanded the
streams. situations where users can use this endpoint to unsubscribe other
users from a stream to include the case where the current user has
access to the stream and is a member of the user group specified by
the `can_remove_subscribers_group_id` for the stream.
**Feature level 160** **Feature level 160**

57
zerver/openapi/zulip.yaml
View File

@ -8738,17 +8738,21 @@ paths:
- Organization administrators can remove any user from any - Organization administrators can remove any user from any
stream. stream.
- Users can remove a bot that they own from any stream that - Users can remove a bot that they own from any stream that
the user can access. the user [can access](/help/stream-permissions).
- Users who can access a stream and are in the group with ID - Users can unsubscribe any user from a stream if they [have
`can_remove_subscribers_group_id` for that stream can access](/help/stream-permissions) to the stream and are a
unsubscribe any user from that stream. member of the [user group](/api/get-user-groups) specified
by the [`can_remove_subscribers_group_id`][can-remove-parameter]
for the stream.
**Changes**: Before Zulip 7.0 (feature level 161), **Changes**: Before Zulip 7.0 (feature level 161), the
`can_remove_subscribers_group_id` was always the system group `can_remove_subscribers_group_id` for all streams was always
for organization administrators. the system group for organization administrators.
Before Zulip 6.0 (feature level 145), users had no special Before Zulip 6.0 (feature level 145), users had no special
privileges for managing bots that they own. privileges for managing bots that they own.
[can-remove-parameter]: /api/subscribe#parameter-can_remove_subscribers_group_id
x-curl-examples-parameters: x-curl-examples-parameters:
oneOf: oneOf:
- type: include - type: include
@ -16154,21 +16158,29 @@ paths:
"user_groups": "user_groups":
[ [
{ {
"description": "Characters of Hamlet", "description": "Owners of this organization",
"id": 1, "id": 1,
"name": "@role:owners",
"members": [1],
"direct_subgroup_ids": [],
"is_system_group": true,
},
{
"description": "Administrators of this organization, including owners",
"id": 2,
"name": "@role:administrators",
"members": [2],
"direct_subgroup_ids": [1],
"is_system_group": true,
},
{
"description": "Characters of Hamlet",
"id": 3,
"name": "hamletcharacters", "name": "hamletcharacters",
"members": [3, 4], "members": [3, 4],
"direct_subgroup_ids": [], "direct_subgroup_ids": [],
"is_system_group": false, "is_system_group": false,
}, },
{
"description": "Moderators",
"id": 2,
"name": "other users",
"members": [1, 2],
"direct_subgroup_ids": [1, 2],
"is_system_group": true,
},
], ],
} }
/user_groups/{user_group_id}/subgroups: /user_groups/{user_group_id}/subgroups:
@ -18910,12 +18922,15 @@ components:
name: can_remove_subscribers_group_id name: can_remove_subscribers_group_id
in: query in: query
description: | description: |
ID of the user group whose members are allowed to unsubscribe others ID of the [user group](/api/get-user-groups) whose members are
from the stream, if they have access to this stream, even if allowed to unsubscribe others from the stream. Note that a user
they are not an organization administrator. who is a member of the specified user group must also [have
access](/help/stream-permissions) to the stream in order to
unsubscribe others.
This setting can currently only be set to system user groups This setting can currently only be set to user groups that are
except `@role:internet` and `@role:owners` group. system groups, except for the system groups named
`"@role:internet"` and `"@role:owners"`.
**Changes**: New in Zulip 7.0 (feature level 161). **Changes**: New in Zulip 7.0 (feature level 161).
schema: schema: