paulmataruso/zulip
1
0
Fork 0
mirror of https://github.com/zulip/zulip.git synced 2025-11-04 05:53:43 +00:00
Code Issues Packages Projects Releases Wiki Activity

api_docs: Update the docs for the POST /messages response.

Browse Source 
This commit updates the API docs for the optional parameter
'automatic_new_visibility_policy' in the `POST /messages` response.

Changes include:
* Explicitly mention that the new visibility policy is still
sent as `user_topic` event.
* Adds a link as a way to understand the meaning of the enum
values '2' and '3'.

Co-authored-by: Tim Abbott <tabbott@zulip.com>
This commit is contained in:
Prakhar Pratyush
2023-10-25 09:07:11 +05:30
committed by Tim Abbott
parent 3385d5862b
commit 3f1cc1b69d
1 changed files with 12 additions and 7 deletions
Download Patch File Download Diff File Expand all files Collapse all files

19
zerver/openapi/zulip.yaml
View File

@@ -6200,13 +6200,18 @@ paths:
Only present if the sender's visibility was in fact changed.
Intended to be used by clients where it is important to explicitly display a
notice that the topic's visibility policy has changed automatically due to
the message sent. The information is also important to correctly decide whether to
display a warning or notice suggesting to unmute the topic after sending a message
to a muted stream. Such a notice might feel confusing in the event that the act of
sending the message had already resulted in the user unmuting or following the topic
in question.
The value can be either [unmuted or followed](/api/update-user-topic#parameter-visibility_policy).
Clients will also be notified about the change in policy via a
`user_topic` event as usual. This field is intended to be used by clients
to explicitly inform the user when a topic's visibility policy was changed
automatically due to sending a message.
For example, the Zulip web application uses this field to decide whether
to display a warning or notice suggesting to unmute the topic after
sending a message to a muted stream. Such a notice would be confusing in
the event that the act of sending the message had already resulted in the
user automatically unmuting or following the topic in question.
**Changes**: New in Zulip 8.0 (feature level 218).
example: