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 Packages Projects Releases Wiki Activity
e797fa4ea1
zulip/templates/zerver/api/get-attachments.md
orientor 817ee5c6b2 openapi_docs: Replace argument with parameter. 
The term `parameter` is a better word than `argument` for data passed
to an API endpoint; this is why OpenAPI uses in their terminology.
Replace `argument` with `parameter` in the API docs to improve their
readability.

Fixes #15435.
2020-06-18 09:18:27 -07:00

545 B
Raw Blame History

Get attachments

{generate_api_description(/attachments:get)}

Usage examples

{start_tabs} {tab|python}

{generate_code_example(python)|/attachments:get|example}

{tab|curl}

{generate_code_example(curl)|/attachments:get|example}

{end_tabs}

Parameters

{generate_api_arguments_table|zulip.yaml|/attachments:get}

Response

Return values

{generate_return_values_table|zulip.yaml|/attachments:get}

Example response

A typical successful JSON response may look like:

{generate_code_example|/attachments:get|fixture(200)}