CodeCow/zulip
1
0
Fork 0
mirror of https://github.com/zulip/zulip.git synced 2026-06-24 21:08:25 +08:00
Code Issues Actions 6 Packages Projects Releases Wiki Activity

apidocs: Move stray message history description to OpenAPI.

Browse Source
This commit is contained in:
Suyash Vardhan Mathur 2021-06-16 17:53:33 +05:30 committed by Tim Abbott
parent 8d7634a572
commit aedca6d6c6
2 changed files with 10 additions and 10 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

10
templates/zerver/api/get-message-history.md
View File

@ -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

10
zerver/openapi/zulip.yaml
View File

@ -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.