api docs: Document historical changes to typing API.

Along with other recent changes, this fixes #13286.
This commit is contained in:
Tim Abbott 2020-03-06 17:49:01 -08:00
parent 043b55b5af
commit 35b444d59c
1 changed files with 7 additions and 2 deletions

View File

@ -2915,10 +2915,15 @@ paths:
required: true required: true
- name: to - name: to
in: query in: query
description: The user_ids of the recipients of the message being typed. description: |
The user_ids of the recipients of the message being typed.
Typing notifications are only supported for private messages. Typing notifications are only supported for private messages.
Send a JSON-encoded list of user_ids. (Use a list even if there is Send a JSON-encoded list of user_ids. (Use a list even if there is
only one recipient.) only one recipient.).
**Changes**: Before Zulip 2.0, this parameter accepted only a JSON-encoded
list of email addresses. The email address-based format is deprecated
and will be removed in Zulip 2.2.
schema: schema:
type: array type: array
items: items: