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

api-changelog: Clarify change in behavior at feature level 152. 

The change in behavior suggesting the need for this clarification is
summarized below, as discussed in the following topic:
https://chat.zulip.org/#narrow/stream/378-api-design/topic/update_message.20default.20notifications
The new text is as suggested by Greg Price.

The change at feature level 152 made the moving of topics within and
between streams more consistent, by applying the optional parameters
introduced for the latter to both cases (`send_notification_to_[new|old]_thread`).

The default for the `old` notification value was changed to `false` at
this point, but the equivalent `new` value was not. This introduced a
change in behavior for existing clients of the API when moving topics
within streams, which now always produce a notification message by
default.

The improved consistency and default behavior for new API clients were
considered primary factors at the time of this change, overriding
concerns over backwards compatbility.
This commit is contained in:
neiljp (Neil Pilgrim) 2023-08-25 12:27:38 -07:00 committed by Tim Abbott
parent f259e85924
commit 53da9ef072
1 changed files with 6 additions and 6 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

12
api_docs/changelog.md
View File

@ -493,12 +493,12 @@ No changes; feature level used for Zulip 6.0 release.
**Feature level 152** **Feature level 152**
* [`PATCH /messages/{message_id}`](/api/update-message): The * [`PATCH /messages/{message_id}`](/api/update-message):
`send_notification_to_old_thread` and The default value for `send_notification_to_old_thread` was changed from
`send_notification_to_new_thread` parameters are now respected when `true` to `false`.
moving a topic within a stream. The default value for When moving a topic within a stream, the `send_notification_to_old_thread`
`send_notification_to_old_thread` was changed from `true` to and `send_notification_to_new_thread` parameters are now respected, and by
`false`. default a notification is sent to the new thread.
**Feature level 151** **Feature level 151**