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

api-docs: Update subscription peer_add and peer_remove events. 

Updates the example for both of these events in the documentation
to be the current version. These were missed when the feature
level 35 updates were made to the API specification for these
events, see commit noted below.

Also, for completeness, adds Changes notes for feature level 35
and feature level 19, for these events.

The feature level 35 changes were made in commit 7ff3859136.
The feature level 19 changes were made in commit 00e60c0c91.
This commit is contained in:
Lauryn Menard 2023-06-21 19:31:51 +02:00 committed by Tim Abbott
parent a810b58418
commit b1b0296a21
2 changed files with 41 additions and 9 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

12
api_docs/changelog.md
View File

@ -1241,8 +1241,10 @@ field with an integer field `invite_to_realm_policy`.
**Feature level 35** **Feature level 35**
* The peer_add and peer_remove subscription events now have plural * [`GET /events`](/api/get-events): The `subscription` events for
versions of `user_ids` and `stream_ids`. `peer_add` and `peer_remove` now include `user_ids` and `stream_ids`
arrays. Previously, these events included singular `user_id` and
`stream_id` integers.
**Feature level 34** **Feature level 34**
@ -1349,9 +1351,9 @@ No changes; feature level used for Zulip 3.0 release.
**Feature level 19** **Feature level 19**
* [`GET /events`](/api/get-events): `subscriptions` event with * [`GET /events`](/api/get-events): The `subscription` events for
`op="peer_add"` and `op="peer_remove"` now identify the modified `peer_add` and `peer_remove` now identify the modified
stream by a `stream_id` field, replacing the old `name` field. stream by the `stream_id` field, replacing the old `name` field.
**Feature level 18** **Feature level 18**

38
zerver/openapi/zulip.yaml
View File

@ -771,6 +771,15 @@ paths:
Event sent to other users when users have been subscribed to Event sent to other users when users have been subscribed to
streams. Sent to all users if the stream is public or to only streams. Sent to all users if the stream is public or to only
the existing subscribers if the stream is private. the existing subscribers if the stream is private.
**Changes**: 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"
@ -787,12 +796,18 @@ paths:
type: array type: array
description: | description: |
The IDs of the streams to which the user has subscribed. The IDs of the streams to which the user has subscribed.
**Changes**: New in Zulip 4.0 (feature level 35), replacing
the `stream_id` integer.
items: items:
type: integer type: integer
user_ids: user_ids:
type: array type: array
description: | description: |
The IDs of the users who subscribed. The IDs of the users who subscribed.
**Changes**: New in Zulip 4.0 (feature level 35), replacing
the `user_id` integer.
items: items:
type: integer type: integer
additionalProperties: false additionalProperties: false
@ -800,8 +815,8 @@ paths:
{ {
"type": "subscription", "type": "subscription",
"op": "peer_add", "op": "peer_add",
"stream_id": 9, "stream_ids": [9],
"user_id": 12, "user_ids": [12],
"id": 0, "id": 0,
} }
- type: object - type: object
@ -809,6 +824,15 @@ paths:
Event sent to other users when users have been unsubscribed Event sent to other users when users have been unsubscribed
from streams. Sent to all users if the stream is public or to only from streams. Sent to all users if the stream is public or to only
the existing subscribers if the stream is private. the existing subscribers if the stream is private.
**Changes**: 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 unsubscribed from,
replacing the `name` field.
properties: properties:
id: id:
$ref: "#/components/schemas/EventIdSchema" $ref: "#/components/schemas/EventIdSchema"
@ -826,12 +850,18 @@ paths:
description: | description: |
The IDs of the streams from which the users have been The IDs of the streams from which the users have been
unsubscribed from. unsubscribed from.
**Changes**: New in Zulip 4.0 (feature level 35), replacing
the `stream_id` integer.
items: items:
type: integer type: integer
user_ids: user_ids:
type: array type: array
description: | description: |
The IDs of the users who have been unsubscribed. The IDs of the users who have been unsubscribed.
**Changes**: New in Zulip 4.0 (feature level 35), replacing
the `user_id` integer.
items: items:
type: integer type: integer
additionalProperties: false additionalProperties: false
@ -839,8 +869,8 @@ paths:
{ {
"type": "subscription", "type": "subscription",
"op": "peer_remove", "op": "peer_remove",
"stream_id": 9, "stream_ids": [9],
"user_id": 12, "user_ids": [12],
"id": 0, "id": 0,
} }
- type: object - type: object