mirror of
https://github.com/zulip/zulip.git
synced 2025-11-02 21:13:36 +00:00
5f07c06040
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.
737 B
737 B
{generate_api_title(/streams:get)}
{generate_api_description(/streams:get)}
Usage examples
{start_tabs} {tab|python}
{generate_code_example(python)|/streams:get|example}
{generate_code_example(javascript)|/streams:get|example}
{tab|curl}
{generate_code_example(curl)|/streams:get|example}
{end_tabs}
Parameters
Note: The following parameters are all URL query parameters.
{generate_api_arguments_table|zulip.yaml|/streams:get}
{generate_parameter_description(/streams:get)}
Response
{generate_return_values_table|zulip.yaml|/streams:get}
{generate_response_description(/streams:get)}
Example response
{generate_code_example|/streams:get|fixture(200)}
{generate_code_example|/streams:get|fixture(400)}