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-streams.md

40 lines
833 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(/streams:get)}
api docs: Document the get-streams endpoint. This commit documents the get-streams endpoint, which can be by making a GET request to /api/v1/streams. Note that in the code examples, JavaScript is missing an example for how to pass in the `include_` query parameters. That is because zulip-js's client.streams.retrieve function doesn't take any arguments and zulip-js does not export any function equivalent to client.call_endpoint in python-zulip-api/zulip.
2017-12-29 06:36:20 +01: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(/streams:get)}
api docs: Document the get-streams endpoint. This commit documents the get-streams endpoint, which can be by making a GET request to /api/v1/streams. Note that in the code examples, JavaScript is missing an example for how to pass in the `include_` query parameters. That is because zulip-js's client.streams.retrieve function doesn't take any arguments and zulip-js does not export any function equivalent to client.call_endpoint in python-zulip-api/zulip.
2017-12-29 06:36:20 +01: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 get-streams endpoint. This commit documents the get-streams endpoint, which can be by making a GET request to /api/v1/streams. Note that in the code examples, JavaScript is missing an example for how to pass in the `include_` query parameters. That is because zulip-js's client.streams.retrieve function doesn't take any arguments and zulip-js does not export any function equivalent to client.call_endpoint in python-zulip-api/zulip.
2017-12-29 06:36:20 +01:00
api docs: Migrate GET /streams to OpenAPI.
2018-06-18 18:53:13 +02:00
{generate_code_example(python)|/streams:get|example}
api docs: Document the get-streams endpoint. This commit documents the get-streams endpoint, which can be by making a GET request to /api/v1/streams. Note that in the code examples, JavaScript is missing an example for how to pass in the `include_` query parameters. That is because zulip-js's client.streams.retrieve function doesn't take any arguments and zulip-js does not export any function equivalent to client.call_endpoint in python-zulip-api/zulip.
2017-12-29 06:36:20 +01:00
api docs: Fix JavaScript example for /streams api endpoint. This commit fixes the JavaScript tab in 'Usage example' for 'Get all streams' that currently shows python code.
2020-10-10 13:45:33 +02:00
{generate_code_example(javascript)|/streams:get|example}
api docs: Document the get-streams endpoint. This commit documents the get-streams endpoint, which can be by making a GET request to /api/v1/streams. Note that in the code examples, JavaScript is missing an example for how to pass in the `include_` query parameters. That is because zulip-js's client.streams.retrieve function doesn't take any arguments and zulip-js does not export any function equivalent to client.call_endpoint in python-zulip-api/zulip.
2017-12-29 06:36:20 +01:00
api docs: Use Markdown extension for tabbed sections.
2018-09-17 16:27:32 +02:00
{tab|curl}
docs: Make get-all-streams use curl example system.
2019-10-10 09:54:14 +02:00
{generate_code_example(curl, include=[""])|/streams:get|example}
api docs: Use Markdown extension for tabbed sections.
2018-09-17 16:27:32 +02:00
You may pass in one or more of the parameters mentioned above
as URL query parameters, like so:
docs: Make get-all-streams use curl example system.
2019-10-10 09:54:14 +02:00
{generate_code_example(curl, include=["include_public"])|/streams:get|example}
api docs: Document the get-streams endpoint. This commit documents the get-streams endpoint, which can be by making a GET request to /api/v1/streams. Note that in the code examples, JavaScript is missing an example for how to pass in the `include_` query parameters. That is because zulip-js's client.streams.retrieve function doesn't take any arguments and zulip-js does not export any function equivalent to client.call_endpoint in python-zulip-api/zulip.
2017-12-29 06:36:20 +01:00
api docs: Use Markdown extension for tabbed sections.
2018-09-17 16:27:32 +02:00
{end_tabs}
api docs: Document the get-streams endpoint. This commit documents the get-streams endpoint, which can be by making a GET request to /api/v1/streams. Note that in the code examples, JavaScript is missing an example for how to pass in the `include_` query parameters. That is because zulip-js's client.streams.retrieve function doesn't take any arguments and zulip-js does not export any function equivalent to client.call_endpoint in python-zulip-api/zulip.
2017-12-29 06:36:20 +01: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: Move code examples farther up.
2018-01-20 22:03:05 +01: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
**Note**: The following parameters are all URL query parameters.
api docs: Move code examples farther up.
2018-01-20 22:03:05 +01:00
api docs: Migrate GET /streams to OpenAPI.
2018-06-18 18:53:13 +02:00
{generate_api_arguments_table|zulip.yaml|/streams:get}
api docs: Move code examples farther up.
2018-01-20 22:03:05 +01:00
api docs: Document the get-streams endpoint. This commit documents the get-streams endpoint, which can be by making a GET request to /api/v1/streams. Note that in the code examples, JavaScript is missing an example for how to pass in the `include_` query parameters. That is because zulip-js's client.streams.retrieve function doesn't take any arguments and zulip-js does not export any function equivalent to client.call_endpoint in python-zulip-api/zulip.
2017-12-29 06:36:20 +01:00
## 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|/streams:get}
api docs: Document the get-streams endpoint. This commit documents the get-streams endpoint, which can be by making a GET request to /api/v1/streams. Note that in the code examples, JavaScript is missing an example for how to pass in the `include_` query parameters. That is because zulip-js's client.streams.retrieve function doesn't take any arguments and zulip-js does not export any function equivalent to client.call_endpoint in python-zulip-api/zulip.
2017-12-29 06:36:20 +01:00
#### Example response
api docs: Migrate GET /streams to OpenAPI.
2018-06-18 18:53:13 +02:00
{generate_code_example|/streams:get|fixture(200)}
api docs: Document the get-streams endpoint. This commit documents the get-streams endpoint, which can be by making a GET request to /api/v1/streams. Note that in the code examples, JavaScript is missing an example for how to pass in the `include_` query parameters. That is because zulip-js's client.streams.retrieve function doesn't take any arguments and zulip-js does not export any function equivalent to client.call_endpoint in python-zulip-api/zulip.
2017-12-29 06:36:20 +01:00
api docs: Migrate GET /streams to OpenAPI.
2018-06-18 18:53:13 +02:00
{generate_code_example|/streams:get|fixture(400)}