paulmataruso/zulip
1
0
Fork 0
mirror of https://github.com/zulip/zulip.git synced 2025-11-03 13:33:24 +00:00
Code Issues Packages Projects Releases Wiki Activity

api docs: Document that new messages might be already ready.

Browse Source 
This is an important and somewhat subtle detail that we'd like to help
clients implement correctly.
This commit is contained in:
Tim Abbott
2021-04-29 10:54:12 -07:00
parent 374ce1094b
commit 2a4452e722
1 changed files with 6 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

6
zerver/openapi/zulip.yaml
View File

@@ -702,6 +702,12 @@ paths:
description: |
The user's [message flags][message-flags] for the message.
Clients should inspect the flags field rather than assuming that
new messages are unread; [muted users](/api/mute-user), messages
sent by the current user, and more subtle scenarios can result
in a new message that the server has already marked as read for
the user.
[message-flags]: /api/update-message-flags#available-flags
items:
type: string