Mirror
/
zulip
mirror of https://github.com/zulip/zulip.git
1
0
Fork 0
Code Issues Projects Releases Wiki Activity

api-docs: Update PATCH /streams/{stream_id} for channel. 

Updates the API doc for PATCH /streams/{stream_id} endpoint to
use channel in descriptions instead of stream.

Part of the stream to channel rename project.
This commit is contained in:
Lauryn Menard 2024-05-20 15:19:51 +02:00 committed by Tim Abbott
parent 75b635d3bc
commit 06b18411fe
1 changed files with 23 additions and 23 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

46
zerver/openapi/zulip.yaml
View File

@ -18188,21 +18188,21 @@ paths:
An example JSON response for when the supplied channel does not exist: An example JSON response for when the supplied channel does not exist:
patch: patch:
operationId: update-stream operationId: update-stream
summary: Update a stream summary: Update a channel
tags: ["streams"] tags: ["streams"]
description: | description: |
Configure the stream with the ID `stream_id`. This endpoint supports Configure the channel with the ID `stream_id`. This endpoint supports
an organization administrator editing any property of a stream, an organization administrator editing any property of a channel,
including: including:
- Stream [name](/help/rename-a-channel) and [description](/help/change-the-channel-description) - Channel [name](/help/rename-a-channel) and [description](/help/change-the-channel-description)
- Stream [permissions](/help/channel-permissions), including - Channel [permissions](/help/channel-permissions), including
[privacy](/help/change-the-privacy-of-a-channel) and [who can [privacy](/help/change-the-privacy-of-a-channel) and [who can
send](/help/channel-posting-policy). send](/help/channel-posting-policy).
Note that an organization administrator's ability to change a Note that an organization administrator's ability to change a
[private stream's permissions](/help/channel-permissions#private-channels) [private channel's permissions](/help/channel-permissions#private-channels)
depends on them being subscribed to the stream. depends on them being subscribed to the channel.
x-curl-examples-parameters: x-curl-examples-parameters:
oneOf: oneOf:
- type: include - type: include
@ -18223,11 +18223,11 @@ paths:
description: description:
description: | description: |
The new [description](/help/change-the-channel-description) for The new [description](/help/change-the-channel-description) for
the stream, in text/markdown format. the channel, in text/markdown format.
Clients should use the `max_stream_description_length` returned Clients should use the `max_stream_description_length` returned
by the [`POST /register`](/api/register-queue) endpoint to by the [`POST /register`](/api/register-queue) endpoint to
determine the maximum stream description length. determine the maximum channel description length.
**Changes**: Removed unnecessary JSON-encoding of this parameter in **Changes**: Removed unnecessary JSON-encoding of this parameter in
Zulip 4.0 (feature level 64). Zulip 4.0 (feature level 64).
@ -18235,11 +18235,11 @@ paths:
example: "Discuss Italian history and travel destinations." example: "Discuss Italian history and travel destinations."
new_name: new_name:
description: | description: |
The new name for the stream. The new name for the channel.
Clients should use the `max_stream_name_length` returned by the Clients should use the `max_stream_name_length` returned by the
[`POST /register`](/api/register-queue) endpoint to determine [`POST /register`](/api/register-queue) endpoint to determine
the maximum stream name length. the maximum channel name length.
**Changes**: Removed unnecessary JSON-encoding of this parameter in **Changes**: Removed unnecessary JSON-encoding of this parameter in
Zulip 4.0 (feature level 64). Zulip 4.0 (feature level 64).
@ -18247,13 +18247,13 @@ paths:
example: Italy example: Italy
is_private: is_private:
description: | description: |
Change whether the stream is a private stream. Change whether the channel is a private channel.
type: boolean type: boolean
example: true example: true
is_announcement_only: is_announcement_only:
deprecated: true deprecated: true
description: | description: |
Whether the stream is limited to announcements. Whether the channel is limited to announcements.
**Changes**: Deprecated in Zulip 3.0 (feature level 1). Clients **Changes**: Deprecated in Zulip 3.0 (feature level 1). Clients
should use `stream_post_policy` instead. should use `stream_post_policy` instead.
@ -18261,9 +18261,9 @@ paths:
example: true example: true
is_web_public: is_web_public:
description: | description: |
Change whether the stream is a web-public stream. Change whether the channel is a web-public channel.
Note that creating web-public streams requires the Note that creating web-public channels requires the
`WEB_PUBLIC_STREAMS_ENABLED` [server setting][server-settings] `WEB_PUBLIC_STREAMS_ENABLED` [server setting][server-settings]
to be enabled on the Zulip server in question, the organization to be enabled on the Zulip server in question, the organization
to have enabled the `enable_spectator_access` realm setting, and to have enabled the `enable_spectator_access` realm setting, and
@ -18277,15 +18277,15 @@ paths:
example: true example: true
history_public_to_subscribers: history_public_to_subscribers:
description: | description: |
Whether the stream's message history should be available to Whether the channel's message history should be available to
newly subscribed members, or users can only access messages newly subscribed members, or users can only access messages
they actually received while subscribed to the stream. they actually received while subscribed to the channel.
Corresponds to the [shared history](/help/channel-permissions) Corresponds to the [shared history](/help/channel-permissions)
option in documentation. option in documentation.
It's an error for this parameter to be false for a public or It's an error for this parameter to be false for a public or
web-public stream and when is_private is false. web-public channel and when is_private is false.
**Changes**: Before Zulip 6.0 (feature level 136), `history_public_to_subscribers` **Changes**: Before Zulip 6.0 (feature level 136), `history_public_to_subscribers`
was silently ignored unless the request also contained either `is_private` or was silently ignored unless the request also contained either `is_private` or
@ -18294,12 +18294,12 @@ paths:
example: false example: false
is_default_stream: is_default_stream:
description: | description: |
Add or remove the stream as a [default stream][default-stream] Add or remove the channel as a [default channel][default-channel]
for new users joining the organization. for new users joining the organization.
[default-stream]: /help/set-default-channels-for-new-users [default-channel]: /help/set-default-channels-for-new-users
**Changes**: New in Zulip 8.0 (feature level 200). Previously, default stream status **Changes**: New in Zulip 8.0 (feature level 200). Previously, default channel status
could only be changed using the [dedicated API endpoint](/api/add-default-stream). could only be changed using the [dedicated API endpoint](/api/add-default-stream).
type: boolean type: boolean
example: false example: false
@ -18336,7 +18336,7 @@ paths:
- allOf: - allOf:
- $ref: "#/components/schemas/InvalidChannelError" - $ref: "#/components/schemas/InvalidChannelError"
- description: | - description: |
An example JSON response for when the supplied stream does not exist: An example JSON response for when the supplied channel does not exist:
- allOf: - allOf:
- $ref: "#/components/schemas/CodedError" - $ref: "#/components/schemas/CodedError"
- example: - example:
@ -18346,7 +18346,7 @@ paths:
"result": "error", "result": "error",
} }
description: | description: |
An example JSON response for when invalid combination of stream permission An example JSON response for when invalid combination of channel permission
parameters are passed: parameters are passed:
/streams/{stream_id}/email_address: /streams/{stream_id}/email_address:
get: get: