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

api-docs: Update /users/me/{stream_id}/topics for channel. 

Updates the API doc for /users/me/{stream_id}/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-19 21:32:53 +02:00 committed by Tim Abbott
parent 559ba55690
commit a090dc32a1
1 changed files with 6 additions and 6 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

12
zerver/openapi/zulip.yaml
View File

@ -9075,17 +9075,17 @@ paths:
/users/me/{stream_id}/topics:
get:
operationId: get-stream-topics
summary: Get topics in a stream
summary: Get topics in a channel
tags: ["streams"]
description: |
Get all topics the user has access to in a specific stream.
Get all topics the user has access to in a specific channel.
Note that for private streams with [protected
Note that for private channels with [protected
history](/help/channel-permissions), the user will only have access to
topics of messages sent after they [subscribed to](/api/subscribe) the
stream. Similarly, a user's [bot](/help/bots-overview#bot-type)
channel. Similarly, a user's [bot](/help/bots-overview#bot-type)
will only have access to messages sent after the bot was subscribed to
the stream, instead of when the user subscribed.
the channel, instead of when the user subscribed.
parameters:
- $ref: "#/components/parameters/ChannelIdInPath"
responses:
@ -9137,7 +9137,7 @@ paths:
- $ref: "#/components/schemas/InvalidChannelError"
- description: |
An example JSON response for when the user is attempting to fetch the topics
of a non-existing stream (or also a private stream they don't have access to):
of a non-existing channel (or also a private channel they don't have access to):
/users/me/subscriptions:
get:
operationId: get-subscriptions