mirror of https://github.com/zulip/zulip.git synced 2026-06-24 21:08:25 +08:00

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

520 B

Raw Blame History

Fetch a development API key

{generate_api_description(/dev_fetch_api_key:post)}

Usage examples

{start_tabs} {tab|curl}

{generate_code_example(curl)|/dev_fetch_api_key:post|example}

{end_tabs}

Parameters

{generate_api_arguments_table|zulip.yaml|/dev_fetch_api_key:post}

Response

Return values

{generate_return_values_table|zulip.yaml|/dev_fetch_api_key:post}

Example response

A typical successful JSON response may look like:

{generate_code_example|/dev_fetch_api_key:post|fixture(200)}

520 B Raw Blame History