From db4b6742707c003ca546ed76a07fb31017d1ec23 Mon Sep 17 00:00:00 2001 From: Suyash Vardhan Mathur Date: Wed, 2 Jun 2021 12:16:07 +0530 Subject: [PATCH] apidocs: Fix description of topic parameter in update_message. The information of topic being required for stream messages in update_message OperationID wasn't true. Fixed the incorrect description. --- zerver/openapi/zulip.yaml | 41 ++++++++++++++++++++++++--------------- 1 file changed, 25 insertions(+), 16 deletions(-) diff --git a/zerver/openapi/zulip.yaml b/zerver/openapi/zulip.yaml index 02de10b941..de7f7781c0 100644 --- a/zerver/openapi/zulip.yaml +++ b/zerver/openapi/zulip.yaml @@ -4302,7 +4302,19 @@ paths: example: [9, 10] required: true - $ref: "#/components/parameters/RequiredContent" - - $ref: "#/components/parameters/Topic" + - name: topic + in: query + description: | + The topic of the message. Only required for stream messages + (`type="stream"`), ignored otherwise. + + 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: + type: string + example: Castle - name: queue_id in: query schema: @@ -4813,7 +4825,18 @@ paths: message you wish you update. parameters: - $ref: "#/components/parameters/MessageId" - - $ref: "#/components/parameters/Topic" + - name: topic + in: query + description: | + The topic of the message. + + 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: + type: string + example: Castle - name: propagate_mode in: query description: | @@ -12259,20 +12282,6 @@ components: type: integer example: 1 required: true - Topic: - name: topic - in: query - description: | - The topic of the message. Only required for stream messages - (`type="stream"`), ignored otherwise. - - 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: - type: string - example: Castle QueueId: name: queue_id in: query