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

api docs: Document changes in API topic encoding.

This commit is contained in:
Tim Abbott 2020-06-25 12:40:55 -07:00
parent 0ecdc663b9
commit 6412ea6413
2 changed files with 8 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

5
templates/zerver/api/changelog.md
View File

@ -258,6 +258,11 @@ below features are supported.
* [`POST /messages`](/api/send-message): Added support for using user * [`POST /messages`](/api/send-message): Added support for using user
IDs and stream IDs for specifying the recipients of a message. IDs and stream IDs for specifying the recipients of a message.
* [`POST /messages`](/api/send-message), [`POST
/messages/{message_id}`](/api/update-message): Added support for
encoding topics using the `topic` parameter name. The previous
`subject` parameter name was deprecated but is still supported for
backwards-compatibility.
* [`POST /set-typing-status`](/api/set-typing-status): Added support for specifying the * [`POST /set-typing-status`](/api/set-typing-status): Added support for specifying the
recipients with user IDs, deprecating the original API of specifying recipients with user IDs, deprecating the original API of specifying
them using email addresses. them using email addresses.

3
zerver/openapi/zulip.yaml
View File

@ -5008,6 +5008,9 @@ components:
(`type="stream"`), ignored otherwise. (`type="stream"`), ignored otherwise.
Maximum length of 60 characters. Maximum length of 60 characters.
**Changes**: New in Zulip 2.0. Previous Zulip releases encoded
this as `subject`, which is currently a deprecated alias.
schema: schema:
type: string type: string
example: Castle example: Castle