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

api-docs: Fix incorrect documentation of subfield in `unread_msgs`. 

Fixes the field in both the pms and huddles objects to be correctly
documented as `unread_message_ids`, instead of `message_ids`.

The documentation of the similar field in the stream object of
`unread_msgs` was corrected in commit 27ddb554fb.
This commit is contained in:
Lauryn Menard 2023-08-28 18:38:12 +02:00 committed by Tim Abbott
parent e8c8544028
commit 0c9fef2444
1 changed files with 2 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
zerver/openapi/zulip.yaml
View File

@ -11712,7 +11712,7 @@ paths:
**Changes**: Deprecated in Zulip 5.0 (feature level 119). **Changes**: Deprecated in Zulip 5.0 (feature level 119).
We expect to provide a next version of the full `unread_msgs` We expect to provide a next version of the full `unread_msgs`
API before removing this legacy name. API before removing this legacy name.
message_ids: unread_message_ids:
type: array type: array
description: | description: |
The message IDs of the recent unread direct messages sent The message IDs of the recent unread direct messages sent
@ -11768,7 +11768,7 @@ paths:
A string containing the IDs of all users in the group A string containing the IDs of all users in the group
direct message conversation separated by commas; for direct message conversation separated by commas; for
example: `"1,2,3"`. example: `"1,2,3"`.
message_ids: unread_message_ids:
type: array type: array
description: | description: |
The message IDs of the recent unread messages which have been sent in The message IDs of the recent unread messages which have been sent in