paulmataruso/zulip
1
0
Fork 0
mirror of https://github.com/zulip/zulip.git synced 2025-11-13 02:17:19 +00:00
Code Issues Packages Projects Releases Wiki Activity

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

Browse Source 
Updates the API doc for GET /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:17:09 +02:00
committed by Tim Abbott
parent 3d9a0aaf90
commit c45aba51aa
1 changed files with 3 additions and 3 deletions
Download Patch File Download Diff File Expand all files Collapse all files

6
zerver/openapi/zulip.yaml
View File

@@ -18110,10 +18110,10 @@ paths:
/streams/{stream_id}: /streams/{stream_id}:
get: get:
operationId: get-stream-by-id operationId: get-stream-by-id
summary: Get a stream by ID summary: Get a channel by ID
tags: ["streams"] tags: ["streams"]
description: | description: |
Fetch details for the stream with the ID `stream_id`. Fetch details for the channel with the ID `stream_id`.
**Changes**: New in Zulip 6.0 (feature level 132). **Changes**: New in Zulip 6.0 (feature level 132).
parameters: parameters:
@@ -18164,7 +18164,7 @@ paths:
allOf: allOf:
- $ref: "#/components/schemas/InvalidChannelError" - $ref: "#/components/schemas/InvalidChannelError"
- description: | - description: |
An example JSON response for when the stream ID is not valid: An example JSON response for when the channel ID is not valid:
delete: delete:
operationId: archive-stream operationId: archive-stream
summary: Archive a stream summary: Archive a stream