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

api-docs: Update POST /default_streams for channel. 

Updates the API doc for POST /default_streams 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-19 20:57:46 +02:00 committed by Tim Abbott
parent 4d0325da99
commit 43cb33df1a
1 changed files with 7 additions and 7 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

14
zerver/openapi/zulip.yaml
View File

@ -5996,13 +5996,13 @@ paths:
post:
operationId: add-default-stream
tags: ["streams"]
summary: Add a default stream
summary: Add a default channel
x-requires-administrator: true
description: |
Add a stream to the set of [default streams][default-streams]
Add a channel to the set of [default channels][default-channels]
for new users joining the organization.
[default-streams]: /help/set-default-channels-for-new-users
[default-channels]: /help/set-default-channels-for-new-users
requestBody:
required: true
content:
@ -6012,7 +6012,7 @@ paths:
properties:
stream_id:
description: |
The ID of the target stream.
The ID of the target channel.
type: integer
example: 10
required:
@ -6032,7 +6032,7 @@ paths:
- allOf:
- $ref: "#/components/schemas/InvalidChannelError"
- description: |
A typical failed JSON response for when an invalid stream ID is passed:
A typical failed JSON response for when an invalid channel ID is passed:
- allOf:
- $ref: "#/components/schemas/CodedError"
- example:
@ -6042,8 +6042,8 @@ paths:
"result": "error",
}
description: |
A typical failed JSON response for when a user tries to add a private stream
to the default streams set:
A typical failed JSON response for when a user tries to add a private channel
to the default channels set:
delete:
operationId: remove-default-stream
summary: Remove a default stream