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

33 lines
563 B
Markdown
Raw Normal View History

api docs: Improve headings and organization for endpoints. Mostly, this is a change in ordering to make more sense, but we also fix several names that were clearly confusing. We restore the convention that each endpoint has the same title at the top of the page as what we have in the sidebar menu, which appears to have been violated in many recent updates to API documentation.
2020-06-19 07:30:42 +02:00
# Add a linkifier
api docs: Document POST /realm/filters.
2018-08-14 02:54:36 +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(/realm/filters:post)}
api docs: Document POST /realm/filters.
2018-08-14 02:54:36 +02:00
## Usage examples
api docs: Use Markdown extension for tabbed sections.
2018-09-17 16:27:32 +02:00
{start_tabs}
{tab|python}
api docs: Document POST /realm/filters.
2018-08-14 02:54:36 +02:00
api docs: Use Markdown extension for tabbed sections.
2018-09-17 16:27:32 +02:00
{generate_code_example(python)|/realm/filters:post|example}
{tab|curl}
api docs: Document POST /realm/filters.
2018-08-14 02:54:36 +02:00
docs: Make add-linkifiers use curl example system.
2019-10-14 11:43:54 +02:00
{generate_code_example(curl)|/realm/filters:post|example}
api docs: Document POST /realm/filters.
2018-08-14 02:54:36 +02:00
api docs: Use Markdown extension for tabbed sections.
2018-09-17 16:27:32 +02:00
{end_tabs}
api docs: Document POST /realm/filters.
2018-08-14 02:54:36 +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 POST /realm/filters.
2018-08-14 02:54:36 +02:00
{generate_api_arguments_table|zulip.yaml|/realm/filters: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|/realm/filters:post}
api docs: Document POST /realm/filters.
2018-08-14 02:54:36 +02:00
#### Example response
A typical successful JSON response may look like:
{generate_code_example|/realm/filters:post|fixture(200)}