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

33 lines
702 B
Markdown
Raw Normal View History

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-19 07:30:42 +02:00
# Update a stream
api_docs: Add documentation for update_stream.
2019-06-23 14:38:28 +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}:patch)}
api_docs: Add documentation for update_stream.
2019-06-23 14:38:28 +02:00
## Usage examples
{start_tabs}
{tab|python}
{generate_code_example(python)|/streams/{stream_id}:patch|example}
{tab|curl}
docs: Make update-stream use curl example system. new_name and description params should be valid JSON strings. The format of these params are marked as json so that the curl example genenrator can convert them into json strings.
2019-10-18 08:47:27 +02:00
{generate_code_example(curl, include=["new_name", "description", "is_private"])|/streams/{stream_id}:patch|example}
api_docs: Add documentation for update_stream.
2019-06-23 14:38:28 +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 update_stream.
2019-06-23 14:38:28 +02:00
{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)}