Mirror
/
zulip
mirror of https://github.com/zulip/zulip.git
1
0
Fork 0
Code Issues Projects Releases Wiki Activity
zulip/templates/zerver/api/remove-emoji-reaction.md

31 lines
631 B
Markdown
Raw Normal View History

api: Document DELETE ../messages/{message_id}/reactions endpoint. This refactors remove_reaction in python_examples.py to validate the result with validate_against_openapi_schema. Minor changes and some additions have been made to the OpenAPI format data for /messages/{message_id}/reactions endpoint.
2020-03-07 11:20:57 +01:00
# Remove an emoji reaction
openapi: Use description markdown for rendering endpoint descriptions. Firstly, change endpoint descriptions in zulip.yaml so that they match their counterpart in the api docs. Then edit the api docs so that they use api description markdown extension for displaying endpoint description.
2020-04-28 20:00:46 +02:00
{generate_api_description(/messages/{message_id}/reactions:delete)}
api: Document DELETE ../messages/{message_id}/reactions endpoint. This refactors remove_reaction in python_examples.py to validate the result with validate_against_openapi_schema. Minor changes and some additions have been made to the OpenAPI format data for /messages/{message_id}/reactions endpoint.
2020-03-07 11:20:57 +01:00
## Usage examples
{start_tabs}
{tab|python}
{generate_code_example(python)|/messages/{message_id}/reactions:delete|example}
{tab|curl}
{generate_code_example(curl, exclude=["emoji_code", "reaction_type"])|/messages/{message_id}/reactions:delete|example}
{end_tabs}
## Arguments
{generate_api_arguments_table|zulip.yaml|/messages/{message_id}/reactions:delete}
## Response
#### Example response
A typical successful JSON response may look like:
{generate_code_example|/messages/{message_id}/reactions:delete|fixture(200)}