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

30 lines
616 B
Markdown
Raw Normal View History

api: Document POST ../messages/{message_id}/reactions endpoint. This refactors add_reaction in python_examples.py to use the openapi_test_function decorator and validate result with validate_against_openapi_schema. Minor changes have been made to the OpenAPI format data for /messages/{message_id}/reactions endpoint. This also adds add-emoji.md to templates/zerver/api and adds add-emoji to rest-endpoints.md (templates/zerver/help/include).
2020-02-29 15:02:34 +01:00
# Add an emoji reaction
openapi: Create markdown extension for rendering endpoint descriptions. Add function in openapi.py to access endpoint descriptions written in zulip.yaml. Use this function for creating a markdown extension for rendering endpoint descriptions written in zulip.yaml. We use this extension for a single endpoint to get test coverage.
2020-04-28 12:13:46 +02:00
{generate_api_description(/messages/{message_id}/reactions:post)}
api: Document POST ../messages/{message_id}/reactions endpoint. This refactors add_reaction in python_examples.py to use the openapi_test_function decorator and validate result with validate_against_openapi_schema. Minor changes have been made to the OpenAPI format data for /messages/{message_id}/reactions endpoint. This also adds add-emoji.md to templates/zerver/api and adds add-emoji to rest-endpoints.md (templates/zerver/help/include).
2020-02-29 15:02:34 +01:00
## Usage examples
{start_tabs}
{tab|python}
{generate_code_example(python)|/messages/{message_id}/reactions:post|example}
{tab|curl}
{generate_code_example(curl, exclude=["emoji_code","reaction_type"])|/messages/{message_id}/reactions:post|example}
{end_tabs}
## Arguments
{generate_api_arguments_table|zulip.yaml|/messages/{message_id}/reactions:post}
## Response
#### Example response
A typical successful JSON response may look like:
{generate_code_example|/messages/{message_id}/reactions:post|fixture(200)}