diff --git a/zerver/openapi/zulip.yaml b/zerver/openapi/zulip.yaml index d9c6e89e77..09c9528aea 100644 --- a/zerver/openapi/zulip.yaml +++ b/zerver/openapi/zulip.yaml @@ -576,14 +576,7 @@ paths: description: | Get the raw content of a message. parameters: - - name: message_id - in: path - description: | - The target message's ID. - schema: - type: integer - example: 42 - required: true + - $ref: '#/components/parameters/MessageId' responses: '200': description: Success. @@ -613,14 +606,7 @@ paths: description: | Edit a message that has already been sent. parameters: - - name: message_id - in: path - description: | - The ID of the message that you wish to edit/update. - schema: - type: integer - example: 42 - required: true + - $ref: '#/components/parameters/MessageId' - $ref: '#/components/parameters/Topic' - name: propagate_mode in: query @@ -670,14 +656,7 @@ paths: description: | Delete a message. parameters: - - name: message_id - in: path - description: | - The ID of the message to delete. - schema: - type: integer - example: 42 - required: true + - $ref: '#/components/parameters/MessageId' responses: '200': description: Success. @@ -705,14 +684,7 @@ paths: description: | Get the different versions of a previously edited message. parameters: - - name: message_id - in: path - description: | - The ID of the message you want to fetch the history of. - schema: - type: integer - example: 42 - required: true + - $ref: '#/components/parameters/MessageId' responses: '200': description: Success. @@ -848,14 +820,7 @@ paths: description: | Add an emoji reaction to a message. parameters: - - name: message_id - in: path - description: | - The ID of the message that you want to add an emoji reaction to. - schema: - type: integer - example: 42 - required: true + - $ref: '#/components/parameters/MessageId' - name: emoji_name in: query description: | @@ -919,14 +884,7 @@ paths: description: | Delete an emoji reaction from a message. parameters: - - name: message_id - in: path - description: | - The ID of the message from which you want to delete the emoji reaction. - schema: - type: integer - example: 41 - required: true + - $ref: '#/components/parameters/MessageId' - name: emoji_name in: query description: | @@ -3660,3 +3618,12 @@ components: type: string example: Hello required: true + MessageId: + name: message_id + in: path + description: | + The target message's ID. + schema: + type: integer + example: 42 + required: true diff --git a/zerver/tests/test_openapi.py b/zerver/tests/test_openapi.py index 0efd2eb1c7..29b335cf11 100644 --- a/zerver/tests/test_openapi.py +++ b/zerver/tests/test_openapi.py @@ -57,7 +57,7 @@ class OpenAPIToolsTest(ZulipTestCase): 'name': 'message_id', 'in': 'path', 'description': - 'The ID of the message that you wish to edit/update.\n', + 'The target message\'s ID.\n', 'example': 42, 'required': True, 'schema': {'type': 'integer'}