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

api-docs: Expands API changelog feature level 134 entry. 

Expands API changelog feature level 134 entry and adds the related
Changes notes to the events documentation for the updates made in
commit f4fcedd: "stream op: create" and "subscription op: peer_add"
events being sent when a private stream is made public.

Those changes were made after the feature level 133 updates, but
before the feature level 134 updates, which is why 134 is the
feature level for the change that is documented for clients.
This commit is contained in:
Lauryn Menard 2023-09-08 17:40:29 +02:00 committed by Tim Abbott
parent fdf41774db
commit 3cd2b6886d
2 changed files with 9 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

3
api_docs/changelog.md
View File

@ -702,6 +702,9 @@ user's profile.
to the response. This generalizes and replaces the previous to the response. This generalizes and replaces the previous
`muted_topics` array, which will no longer be sent if `user_topic` `muted_topics` array, which will no longer be sent if `user_topic`
is included in `fetch_event_types`. is included in `fetch_event_types`.
* [`GET /events`](/api/get-events): When private streams are made
public, `stream` events for `op: "create"` and `subscription` events
for `op: "peer_add"` are now sent to clients.
**Feature level 133** **Feature level 133**

6
zerver/openapi/zulip.yaml
View File

@ -776,6 +776,9 @@ paths:
sent when a user gained access to a stream due to their [role sent when a user gained access to a stream due to their [role
changing](/help/roles-and-permissions). changing](/help/roles-and-permissions).
Prior to Zulip 6.0 (feature level 134), this event was not sent when a
private stream was made public.
In Zulip 4.0 (feature level 35), the singular `user_id` and `stream_id` 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 integers included in this event were replaced with plural `user_ids` and
`stream_ids` integer arrays. `stream_ids` integer arrays.
@ -1191,6 +1194,9 @@ paths:
Prior to Zulip 8.0 (feature level 192), this event was not sent Prior to Zulip 8.0 (feature level 192), this event was not sent
when guest users gained access to a public stream by being when guest users gained access to a public stream by being
subscribed. subscribed.
Prior to Zulip 6.0 (feature level 134), this event was not sent
when a private stream was made public.
properties: properties:
id: id:
$ref: "#/components/schemas/EventIdSchema" $ref: "#/components/schemas/EventIdSchema"