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

api-docs: Update subscription event for peer_add feature level 205. 

In commit ada2991f1c, when a user gains access to a stream due to
a role change, in addition to sending "stream op: create" events,
"subscription op: peer_add" events are sent for streams that the
user gains access to due to their role change. Updates the API
changelog entry for feature level 205.

Updates the "subcription op: peer_add" event documentation to be
more accurate in for the general use cases of this event, which
are to provide updated subscriber information for streams that
a user has access to.
This commit is contained in:
Lauryn Menard 2023-09-05 13:30:58 +02:00 committed by Tim Abbott
parent 902498ec4f
commit fdf41774db
2 changed files with 23 additions and 12 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

3
api_docs/changelog.md
View File

@ -83,6 +83,9 @@ format used by the Zulip server that they are interacting with.
* [`GET /events`](/api/get-events): Events for stream creation and deletion * [`GET /events`](/api/get-events): Events for stream creation and deletion
are now sent to clients when a user gains or loses access to any streams are now sent to clients when a user gains or loses access to any streams
due to a change in their [role](/help/roles-and-permissions). due to a change in their [role](/help/roles-and-permissions).
* [`GET /events`](/api/get-events): The `subscription` events for `op:
"peer_add"` are now sent to clients when a user gains access to a stream
due to a change in their role.
**Feature level 204** **Feature level 204**

32
zerver/openapi/zulip.yaml
View File

@ -763,18 +763,25 @@ paths:
} }
- type: object - type: object
description: | description: |
Event sent to other users when users have been subscribed to Event sent when another user subscribes to a stream, or their
streams. Sent to all users if the stream is public or to only subscription is newly visible to the current user.
the existing subscribers if the stream is private.
**Changes**: In Zulip 4.0 (feature level 35), the singular When a user subscribes to a stream, the current user will receive this
`user_id` and `stream_id` integers included in this event event only if they [have permission to see the stream's subscriber
were replaced with plural `user_ids` and `stream_ids` integer list](/help/stream-permissions). When the current user gains permission
arrays. to see a given stream's subscriber list, they will receive this event
for the existing subscriptions to the stream.
In Zulip 3.0 (feature level 19), the `stream_id` field was **Changes**: Prior to Zulip 8.0 (feature level 205), this event was not
added to identify the stream the user subscribed to, sent when a user gained access to a stream due to their [role
replacing the `name` field. changing](/help/roles-and-permissions).
In Zulip 4.0 (feature level 35), the singular `user_id` and `stream_id`
integers included in this event were replaced with plural `user_ids` and
`stream_ids` integer arrays.
In Zulip 3.0 (feature level 19), the `stream_id` field was added to
identify the stream the user subscribed to, replacing the `name` field.
properties: properties:
id: id:
$ref: "#/components/schemas/EventIdSchema" $ref: "#/components/schemas/EventIdSchema"
@ -790,7 +797,7 @@ paths:
stream_ids: stream_ids:
type: array type: array
description: | description: |
The IDs of the streams to which the user has subscribed. The IDs of streams that have new or updated subscriber data.
**Changes**: New in Zulip 4.0 (feature level 35), replacing **Changes**: New in Zulip 4.0 (feature level 35), replacing
the `stream_id` integer. the `stream_id` integer.
@ -799,7 +806,8 @@ paths:
user_ids: user_ids:
type: array type: array
description: | description: |
The IDs of the users who subscribed. The IDs of the users who are newly visible as subscribed to
the specified streams.
**Changes**: New in Zulip 4.0 (feature level 35), replacing **Changes**: New in Zulip 4.0 (feature level 35), replacing
the `user_id` integer. the `user_id` integer.