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

33 lines
756 B
Markdown
Raw Normal View History

apidocs: Replace hardcoded titles with generated ones. This commit replaces the hardcoded titles of /api pages with the auto-generated ones from the openapi data using the markdown processor.
2021-05-22 13:21:18 +02:00
{generate_api_title(/users/me/{stream_id}/topics:get)}
api docs: Document the /users/me/<stream_id>/topics endpoint.
2018-06-01 18:58:07 +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(/users/me/{stream_id}/topics:get)}
api docs: Document the /users/me/<stream_id>/topics endpoint.
2018-06-01 18:58:07 +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 the /users/me/<stream_id>/topics endpoint.
2018-06-01 18:58:07 +02:00
{generate_code_example(python)|/users/me/{stream_id}/topics:get|example}
js_examples: Migrate and test get_stream_topics example.
2020-06-21 22:32:42 +02:00
{generate_code_example(javascript)|/users/me/{stream_id}/topics:get|example}
api docs: Document the /users/me/<stream_id>/topics endpoint.
2018-06-01 18:58:07 +02:00
api docs: Use Markdown extension for tabbed sections.
2018-09-17 16:27:32 +02:00
{tab|curl}
docs: Make get-stream-topics use curl example system.
2019-10-11 13:16:53 +02:00
{generate_code_example(curl)|/users/me/{stream_id}/topics:get|example}
api docs: Document the /users/me/<stream_id>/topics endpoint.
2018-06-01 18:58:07 +02:00
api docs: Use Markdown extension for tabbed sections.
2018-09-17 16:27:32 +02:00
{end_tabs}
api docs: Document the /users/me/<stream_id>/topics endpoint.
2018-06-01 18:58:07 +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 /users/me/<stream_id>/topics endpoint.
2018-06-01 18:58:07 +02:00
{generate_api_arguments_table|zulip.yaml|/users/me/{stream_id}/topics:get}
## Response
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|/users/me/{stream_id}/topics:get}
api docs: Document the /users/me/<stream_id>/topics endpoint.
2018-06-01 18:58:07 +02:00
#### Example response
{generate_code_example|/users/me/{stream_id}/topics:get|fixture(200)}
{generate_code_example|/users/me/{stream_id}/topics:get|fixture(400)}