Files
zulip/templates/zerver/api/check-messages-match-narrow.md
Suyash Vardhan Mathur 5f07c06040 openapi: Auto render response descriptions.
This commit modifies the templates to
auto-generate general descriptions of
responses directly from the newly
added field of x-response-description
as a part of the goal of a common template.
2021-06-22 10:58:43 -07:00

846 B

{generate_api_title(/messages/matches_narrow:get)}

{generate_api_description(/messages/matches_narrow:get)}

Usage examples

{start_tabs} {tab|python}

{generate_code_example(python)|/messages/matches_narrow:get|example}

{generate_code_example(javascript)|/messages/matches_narrow:get|example}

{tab|curl}

{generate_code_example(curl)|/messages/matches_narrow:get|example}

{end_tabs}

Arguments

{generate_api_arguments_table|zulip.yaml|/messages/matches_narrow:get}

{generate_parameter_description(/messages/matches_narrow:get)}

Response

{generate_return_values_table|zulip.yaml|/messages/matches_narrow:get}

{generate_response_description(/messages/matches_narrow:get)}

Example response

{generate_code_example|/messages/matches_narrow:get|fixture(200)}

{generate_code_example|/messages/matches_narrow:get|fixture(400)}