From 35b444d59cb00ba2ca2973a5f7fef42f844ab445 Mon Sep 17 00:00:00 2001 From: Tim Abbott Date: Fri, 6 Mar 2020 17:49:01 -0800 Subject: [PATCH] api docs: Document historical changes to typing API. Along with other recent changes, this fixes #13286. --- zerver/openapi/zulip.yaml | 9 +++++++-- 1 file changed, 7 insertions(+), 2 deletions(-) diff --git a/zerver/openapi/zulip.yaml b/zerver/openapi/zulip.yaml index 5ab9eb91ec..03e2cfee38 100644 --- a/zerver/openapi/zulip.yaml +++ b/zerver/openapi/zulip.yaml @@ -2915,10 +2915,15 @@ paths: required: true - name: to 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. 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: type: array items: