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

35 lines
724 B
Markdown
Raw Normal View History

streams: Use "archive stream" phrasing instead of "delete stream". The previous phrasing was misleading in relation to what the action actually does.
2021-03-31 16:15:24 +02:00
# Archive a stream
api_docs: Add documentation for delete_stream.
2019-06-22 08:22:32 +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(/streams/{stream_id}:delete)}
api_docs: Add documentation for delete_stream.
2019-06-22 08:22:32 +02:00
## Usage examples
{start_tabs}
{tab|python}
{generate_code_example(python)|/streams/{stream_id}:delete|example}
{tab|curl}
docs: Make delete-stream use curl example system.
2019-10-11 14:33:02 +02:00
{generate_code_example(curl)|/streams/{stream_id}:delete|example}
api_docs: Add documentation for delete_stream.
2019-06-22 08:22:32 +02:00
{end_tabs}
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: Add documentation for delete_stream.
2019-06-22 08:22:32 +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
**Note**: The following parameters are all URL query parameters.
api_docs: Add documentation for delete_stream.
2019-06-22 08:22:32 +02:00
{generate_api_arguments_table|zulip.yaml|/streams/{stream_id}:delete}
## Response
#### Example response
A typical successful JSON response may look like:
{generate_code_example|/streams/{stream_id}:delete|fixture(200)}
An example JSON response for when the supplied stream does not exist:
{generate_code_example|/streams/{stream_id}:delete|fixture(400)}