diff --git a/templates/zerver/api/get-messages.md b/templates/zerver/api/get-messages.md index 2c166a2706..ab9a466389 100644 --- a/templates/zerver/api/get-messages.md +++ b/templates/zerver/api/get-messages.md @@ -25,10 +25,6 @@ ## Response -When a request is successful, this endpoint returns a dictionary -containing the following (in addition to the `msg` and `result` keys -present in all Zulip API responses). - {generate_return_values_table|zulip.yaml|/messages:get} {generate_response_description(/messages:get)} diff --git a/zerver/openapi/zulip.yaml b/zerver/openapi/zulip.yaml index 13d925df50..b40afa9490 100644 --- a/zerver/openapi/zulip.yaml +++ b/zerver/openapi/zulip.yaml @@ -4223,8 +4223,12 @@ paths: schema: allOf: - $ref: "#/components/schemas/JsonSuccessBase" - - $ref: "#/components/schemas/SuccessDescription" - additionalProperties: false + description: | + When a request is successful, this endpoint returns a dictionary + containing the following (in addition to the `msg` and `result` keys + present in all Zulip API responses). + A typical successful JSON response may look like properties: result: {} msg: {}