Mirror
/
zulip
mirror of https://github.com/zulip/zulip.git
1
0
Fork 0
Code Issues Projects Releases Wiki Activity
zulip/templates/zerver/api/dev-fetch-api-key.md

29 lines
528 B
Markdown
Raw Normal View History

api_docs: Document the /fetch-api-key endpoint. With tweaks by tabbott to document addition details. Fixes: #16408.
2020-10-03 02:40:10 +02:00
# Fetch an API key (development only)
api docs: Document the /dev_fetch_api_key endpoint.
2018-06-21 15:23:10 +02:00
openapi: Use description markdown for rendering endpoint descriptions. Firstly, change endpoint descriptions in zulip.yaml so that they match their counterpart in the api docs. Then edit the api docs so that they use api description markdown extension for displaying endpoint description.
2020-04-28 20:00:46 +02:00
{generate_api_description(/dev_fetch_api_key:post)}
api docs: Document the /dev_fetch_api_key endpoint.
2018-06-21 15:23:10 +02:00
## Usage examples
api_docs: Use tabbed_sections extension in new API docs.
2018-10-18 00:14:30 +02:00
{start_tabs}
{tab|curl}
api docs: Document the /dev_fetch_api_key endpoint.
2018-06-21 15:23:10 +02:00
docs: Make dev-fetch-api-key use curl example system.
2019-10-14 12:49:04 +02:00
{generate_code_example(curl)|/dev_fetch_api_key:post|example}
api docs: Document the /dev_fetch_api_key endpoint.
2018-06-21 15:23:10 +02:00
api_docs: Use tabbed_sections extension in new API docs.
2018-10-18 00:14:30 +02:00
{end_tabs}
api docs: Document the /dev_fetch_api_key endpoint.
2018-06-21 15:23:10 +02:00
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 15:35:25 +02:00
## Parameters
api docs: Document the /dev_fetch_api_key endpoint.
2018-06-21 15:23:10 +02:00
{generate_api_arguments_table|zulip.yaml|/dev_fetch_api_key:post}
## Response
#### Return values
openapi: Add markdown extension for rendering return values in API docs. Currently response return values have to be written twice, once in the docs and once in zulip.yaml. Create a markdown extension so that the return values in api docs are rendered using content from zulip.yaml
2020-05-20 11:57:57 +02:00
{generate_return_values_table|zulip.yaml|/dev_fetch_api_key:post}
api docs: Document the /dev_fetch_api_key endpoint.
2018-06-21 15:23:10 +02:00
#### Example response
A typical successful JSON response may look like:
{generate_code_example|/dev_fetch_api_key:post|fixture(200)}