mirror of https://github.com/zulip/zulip.git synced 2025-11-03 21:43:21 +00:00

Files

Tim Abbott bfc30e4214 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-18 22:38:05 -07:00

723 B

Raw Blame History

Delete a stream

{generate_api_description(/streams/{stream_id}:delete)}

Usage examples

{start_tabs} {tab|python}

{generate_code_example(python)|/streams/{stream_id}:delete|example}

{tab|curl}

{generate_code_example(curl)|/streams/{stream_id}:delete|example}

{end_tabs}

Parameters

Note: The following parameters are all URL query parameters.

{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)}

723 B Raw Blame History