CodeCow/zulip
1
0
Fork 0
mirror of https://github.com/zulip/zulip.git synced 2026-07-03 21:10:12 +08:00
Code Issues Actions 4 Packages Projects Releases Wiki Activity
544e472ec3
zulip/templates/zerver/api/api-doc-template.md
Anders Kaseorg 946a0565c6 openapi: Fuse generate_api_title with generate_api_description. 
Signed-off-by: Anders Kaseorg <anders@zulip.com>
2022-07-22 16:41:55 -07:00

606 B
Raw Blame History

{generate_api_header(API_ENDPOINT_NAME)}

Usage examples

{start_tabs}

{generate_code_example(python)|API_ENDPOINT_NAME|example}

{generate_code_example(javascript)|API_ENDPOINT_NAME|example}

{tab|curl}

{generate_code_example(curl)|API_ENDPOINT_NAME|example}

{end_tabs}

Parameters

{generate_api_arguments_table|zulip.yaml|API_ENDPOINT_NAME}

{generate_parameter_description(API_ENDPOINT_NAME)}

Response

{generate_return_values_table|zulip.yaml|API_ENDPOINT_NAME}

{generate_response_description(API_ENDPOINT_NAME)}

Example response

{generate_code_example|API_ENDPOINT_NAME|fixture}