mirror of https://github.com/zulip/zulip.git
api-docs: Add changelog for `stream_id` param to `mute-topic`.
Adds a changelog 2.0 entry for adding support for `stream_id` parameter to the `mute-topic` endpoint. Also, adds Changes note to the endpoint parameter description, and reorders/clarifies that at least one (and only one) stream parameter must be provided by the client and that the `string_id` parameter is preferred. Fixes #11136.
This commit is contained in:
parent
ce34b585a5
commit
7ceb5f6311
|
@ -1080,6 +1080,9 @@ No changes; feature level used for Zulip 3.0 release.
|
||||||
|
|
||||||
## Changes in Zulip 2.0
|
## Changes in Zulip 2.0
|
||||||
|
|
||||||
|
* [`PATCH /users/me/subscriptions/muted_topics`](/api/mute-topic):
|
||||||
|
Added support for using stream IDs to specify the stream in which to
|
||||||
|
mute/unmute a topic.
|
||||||
* [`POST /messages`](/api/send-message): Added support for using user
|
* [`POST /messages`](/api/send-message): Added support for using user
|
||||||
IDs and stream IDs for specifying the recipients of a message.
|
IDs and stream IDs for specifying the recipients of a message.
|
||||||
* [`POST /messages`](/api/send-message), [`POST
|
* [`POST /messages`](/api/send-message), [`POST
|
||||||
|
|
|
@ -7447,22 +7447,31 @@ paths:
|
||||||
enum:
|
enum:
|
||||||
- stream_id
|
- stream_id
|
||||||
parameters:
|
parameters:
|
||||||
- name: stream
|
|
||||||
in: query
|
|
||||||
description: |
|
|
||||||
The name of the stream to access.
|
|
||||||
schema:
|
|
||||||
type: string
|
|
||||||
example: Denmark
|
|
||||||
required: false
|
|
||||||
- name: stream_id
|
- name: stream_id
|
||||||
in: query
|
in: query
|
||||||
description: |
|
description: |
|
||||||
The ID of the stream to access.
|
The ID of the stream to access.
|
||||||
|
|
||||||
|
Clients must provide either `stream` or `stream_id` as a parameter
|
||||||
|
to this endpoint, but not both.
|
||||||
|
|
||||||
|
**Changes**: New in Zulip 2.0.
|
||||||
schema:
|
schema:
|
||||||
type: integer
|
type: integer
|
||||||
example: 43
|
example: 43
|
||||||
required: false
|
required: false
|
||||||
|
- name: stream
|
||||||
|
in: query
|
||||||
|
description: |
|
||||||
|
The name of the stream to access.
|
||||||
|
|
||||||
|
Clients must provide either `stream` or `stream_id` as a parameter
|
||||||
|
to this endpoint, but not both. Clients should use `stream_id`
|
||||||
|
instead of the `stream` parameter when possible.
|
||||||
|
schema:
|
||||||
|
type: string
|
||||||
|
example: Denmark
|
||||||
|
required: false
|
||||||
- name: topic
|
- name: topic
|
||||||
in: query
|
in: query
|
||||||
description: |
|
description: |
|
||||||
|
|
Loading…
Reference in New Issue