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

45 lines
912 B
Markdown
Raw Normal View History

api docs: Document the GET /api/v1/get_stream_id endpoint. This commit documents the /api/v1/get_stream_id endpoint. Note that there is currently no way to interface with this endpoint with zulip-js.
2017-12-29 23:58:37 +01:00
# Get stream ID
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(/get_stream_id:get)}
api docs: Document the GET /api/v1/get_stream_id endpoint. This commit documents the /api/v1/get_stream_id endpoint. Note that there is currently no way to interface with this endpoint with zulip-js.
2017-12-29 23:58:37 +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 /api/v1/get_stream_id endpoint. This commit documents the /api/v1/get_stream_id endpoint. Note that there is currently no way to interface with this endpoint with zulip-js.
2017-12-29 23:58:37 +01:00
api docs: Migrate GET /get_stream_id to OpenAPI.
2018-06-18 19:20:55 +02:00
{generate_code_example(python)|/get_stream_id:get|example}
api docs: Document the GET /api/v1/get_stream_id endpoint. This commit documents the /api/v1/get_stream_id endpoint. Note that there is currently no way to interface with this endpoint with zulip-js.
2017-12-29 23:58:37 +01:00
api docs: Use Markdown extension for tabbed sections.
2018-09-17 16:27:32 +02:00
{tab|js}
api docs: Document the GET /api/v1/get_stream_id endpoint. This commit documents the /api/v1/get_stream_id endpoint. Note that there is currently no way to interface with this endpoint with zulip-js.
2017-12-29 23:58:37 +01:00
api/get-stream-id: Add JavaScript example.
2018-01-13 22:57:05 +01:00
More examples and documentation can be found [here](https://github.com/zulip/zulip-js).
js_examples: Migrate and test get_stream_id example.
2020-06-21 22:25:48 +02:00
{generate_code_example(javascript)|/get_stream_id:get|example}
api/get-stream-id: Add JavaScript example.
2018-01-13 22:57:05 +01:00
api docs: Use Markdown extension for tabbed sections.
2018-09-17 16:27:32 +02:00
{tab|curl}
docs: Make get-stream-id use curl example system.
2019-10-11 14:27:25 +02:00
{generate_code_example(curl)|/get_stream_id:get|example}
api docs: Document the GET /api/v1/get_stream_id endpoint. This commit documents the /api/v1/get_stream_id endpoint. Note that there is currently no way to interface with this endpoint with zulip-js.
2017-12-29 23:58:37 +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 /api/v1/get_stream_id endpoint. This commit documents the /api/v1/get_stream_id endpoint. Note that there is currently no way to interface with this endpoint with zulip-js.
2017-12-29 23:58:37 +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 /get_stream_id to OpenAPI.
2018-06-18 19:20:55 +02:00
{generate_api_arguments_table|zulip.yaml|/get_stream_id:get}
api docs: Move code examples farther up.
2018-01-20 22:03:05 +01:00
api docs: Document the GET /api/v1/get_stream_id endpoint. This commit documents the /api/v1/get_stream_id endpoint. Note that there is currently no way to interface with this endpoint with zulip-js.
2017-12-29 23:58:37 +01:00
## 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|/get_stream_id:get}
api docs: Document the GET /api/v1/get_stream_id endpoint. This commit documents the /api/v1/get_stream_id endpoint. Note that there is currently no way to interface with this endpoint with zulip-js.
2017-12-29 23:58:37 +01:00
#### Example response
A typical successful JSON response may look like:
api docs: Migrate GET /get_stream_id to OpenAPI.
2018-06-18 19:20:55 +02:00
{generate_code_example|/get_stream_id:get|fixture(200)}
api docs: Document the GET /api/v1/get_stream_id endpoint. This commit documents the /api/v1/get_stream_id endpoint. Note that there is currently no way to interface with this endpoint with zulip-js.
2017-12-29 23:58:37 +01:00
api docs: Make minor phrasing improvement.
2018-06-01 18:52:53 +02:00
An example JSON response for when the supplied stream does not exist:
api docs: Document the GET /api/v1/get_stream_id endpoint. This commit documents the /api/v1/get_stream_id endpoint. Note that there is currently no way to interface with this endpoint with zulip-js.
2017-12-29 23:58:37 +01:00
api docs: Migrate GET /get_stream_id to OpenAPI.
2018-06-18 19:20:55 +02:00
{generate_code_example|/get_stream_id:get|fixture(400)}