From 43cb33df1aac0754518ef0d200b7b622139079e0 Mon Sep 17 00:00:00 2001 From: Lauryn Menard Date: Sun, 19 May 2024 20:57:46 +0200 Subject: [PATCH] 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. --- zerver/openapi/zulip.yaml | 14 +++++++------- 1 file changed, 7 insertions(+), 7 deletions(-) diff --git a/zerver/openapi/zulip.yaml b/zerver/openapi/zulip.yaml index 038439de84..1993dad895 100644 --- a/zerver/openapi/zulip.yaml +++ b/zerver/openapi/zulip.yaml @@ -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