api-docs: Clarify what topics are returned by `get-stream-topics`.

Updates the main description for the `get-stream-topics` endpoint
so that it is clear that the topics for private streams with protected
history are limited to the topics / messages the user has access to.

And updates that documentation and the help center documentation for
bot permissions / abilities, to clarify that bots have the same
restriction and can only access messages / topics that are sent after
the bot (not the bot's owner) subscribed to the stream.
This commit is contained in:
Lauryn Menard 2023-06-13 19:23:32 +02:00 committed by Tim Abbott
parent 92a1e3464d
commit e1c809a71e
2 changed files with 13 additions and 1 deletions

View File

@ -55,6 +55,11 @@ A few more details:
* Bots can be subscribed to streams, and their role can be modified if * Bots can be subscribed to streams, and their role can be modified if
they need to have permission to do administrative actions. they need to have permission to do administrative actions.
* [Stream permissions](/help/stream-permissions) are the same for bots
as for other users. Therefore, for private streams with protected
history, a bot can only access messages sent after it subscribed
to the stream.
* **Generic**: A generic bot is like a normal Zulip user account that * **Generic**: A generic bot is like a normal Zulip user account that
cannot log in via a browser. Note that if you truly want to cannot log in via a browser. Note that if you truly want to
impersonate yourself (e.g. write messages that come from your Zulip impersonate yourself (e.g. write messages that come from your Zulip

View File

@ -8283,7 +8283,14 @@ paths:
summary: Get topics in a stream summary: Get topics in a stream
tags: ["streams"] tags: ["streams"]
description: | description: |
Get all the topics in a specific stream Get all topics the user has access to in a specific stream.
Note that for private streams with [protected
history](/help/stream-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-and-integrations#bot-type)
will only have access to messages sent after the bot was subscribed to
the stream, instead of when the user subscribed.
parameters: parameters:
- $ref: "#/components/parameters/StreamIdInPath" - $ref: "#/components/parameters/StreamIdInPath"
responses: responses: