From aedca6d6c6e98e1affb3fac4df7652a0b66fbeea Mon Sep 17 00:00:00 2001
From: Suyash Vardhan Mathur <suyash.mathur@research.iiit.ac.in>
Date: Wed, 16 Jun 2021 17:53:33 +0530
Subject: [PATCH] apidocs: Move stray message history description to OpenAPI.

---
 templates/zerver/api/get-message-history.md | 10 ----------
 zerver/openapi/zulip.yaml                   | 10 ++++++++++
 2 files changed, 10 insertions(+), 10 deletions(-)

diff --git a/templates/zerver/api/get-message-history.md b/templates/zerver/api/get-message-history.md
index 61ab20b264..45aa89e4ca 100644
--- a/templates/zerver/api/get-message-history.md
+++ b/templates/zerver/api/get-message-history.md
@@ -27,16 +27,6 @@
 
 {generate_return_values_table|zulip.yaml|/messages/{message_id}/history:get}
 
-Please note that the original message's snapshot only contains the fields
-`topic`, `content`, `rendered_content`, `timestamp` and `user_id`. This
-snapshot will be the only one present if the message has never been edited.
-
-Also note that if a message's content was edited (but not the topic)
-or the topic was edited (but not the content), the snapshot object
-will only contain data for the modified fields (e.g. if only the topic
-was edited, `prev_content`, `prev_rendered_content`, and
-`content_html_diff` will not appear).
-
 {generate_response_description(/messages/{message_id}/history:get)}
 
 #### Example response
diff --git a/zerver/openapi/zulip.yaml b/zerver/openapi/zulip.yaml
index 67714e0b73..9c9d4672c2 100644
--- a/zerver/openapi/zulip.yaml
+++ b/zerver/openapi/zulip.yaml
@@ -4471,6 +4471,16 @@ paths:
         [edit-settings]: /help/view-a-messages-edit-history
       parameters:
         - $ref: "#/components/parameters/MessageId"
+      x-response-description: |
+        Please note that the original message's snapshot only contains the fields
+        `topic`, `content`, `rendered_content`, `timestamp` and `user_id`. This
+        snapshot will be the only one present if the message has never been edited.
+
+        Also note that if a message's content was edited (but not the topic)
+        or the topic was edited (but not the content), the snapshot object
+        will only contain data for the modified fields (e.g. if only the topic
+        was edited, `prev_content`, `prev_rendered_content`, and
+        `content_html_diff` will not appear).
       responses:
         "200":
           description: Success.