mirror of
https://github.com/zulip/zulip.git
synced 2026-07-12 21:04:41 +08:00
bfc30e4214
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.
33 lines
702 B
Markdown
33 lines
702 B
Markdown
# Update a stream
|
|
|
|
{generate_api_description(/streams/{stream_id}:patch)}
|
|
|
|
## Usage examples
|
|
|
|
{start_tabs}
|
|
{tab|python}
|
|
|
|
{generate_code_example(python)|/streams/{stream_id}:patch|example}
|
|
|
|
{tab|curl}
|
|
|
|
{generate_code_example(curl, include=["new_name", "description", "is_private"])|/streams/{stream_id}:patch|example}
|
|
|
|
{end_tabs}
|
|
|
|
## Parameters
|
|
|
|
{generate_api_arguments_table|zulip.yaml|/streams/{stream_id}:patch}
|
|
|
|
## Response
|
|
|
|
#### Example response
|
|
|
|
A typical successful JSON response may look like:
|
|
|
|
{generate_code_example|/streams/{stream_id}:patch|fixture(200)}
|
|
|
|
An example JSON response for when the supplied stream does not exist:
|
|
|
|
{generate_code_example|/streams/{stream_id}:patch|fixture(400)}
|