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

api-docs: Update POST /user_topics for channel. 

Updates the API doc for POST /user_topics endpoint to use channel in
descriptions instead of stream.

Part of the stream to channel rename project.
This commit is contained in:
Lauryn Menard 2024-05-20 13:54:12 +02:00 committed by Tim Abbott
parent c34e3a9eba
commit 880ab441f6
1 changed files with 5 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

10
zerver/openapi/zulip.yaml
View File

@ -9853,7 +9853,7 @@ paths:
[mute a topic](/help/mute-a-topic) and related features. [mute a topic](/help/mute-a-topic) and related features.
This endpoint can be used to update the visibility policy for the single This endpoint can be used to update the visibility policy for the single
stream and topic pair indicated by the parameters for a user. channel and topic pair indicated by the parameters for a user.
**Changes**: New in Zulip 7.0 (feature level 170). Previously, **Changes**: New in Zulip 7.0 (feature level 170). Previously,
toggling whether a topic was muted or unmuted was managed by the toggling whether a topic was muted or unmuted was managed by the
@ -9867,7 +9867,7 @@ paths:
properties: properties:
stream_id: stream_id:
description: | description: |
The ID of the stream to access. The ID of the channel to access.
type: integer type: integer
example: 1 example: 1
topic: topic:
@ -9886,11 +9886,11 @@ paths:
Controls which visibility policy to set. Controls which visibility policy to set.
- 0 = None. Removes the visibility policy previously set for the topic. - 0 = None. Removes the visibility policy previously set for the topic.
- 1 = Muted. [Mutes the topic](/help/mute-a-topic) in a stream. - 1 = Muted. [Mutes the topic](/help/mute-a-topic) in a channel.
- 2 = Unmuted. [Unmutes the topic](/help/mute-a-topic) in a muted stream. - 2 = Unmuted. [Unmutes the topic](/help/mute-a-topic) in a muted channel.
- 3 = Followed. [Follows the topic](/help/follow-a-topic). - 3 = Followed. [Follows the topic](/help/follow-a-topic).
In an unmuted stream, a topic visibility policy of unmuted will have the In an unmuted channel, a topic visibility policy of unmuted will have the
same effect as the "None" visibility policy. same effect as the "None" visibility policy.
**Changes**: In Zulip 7.0 (feature level 219), added followed as **Changes**: In Zulip 7.0 (feature level 219), added followed as