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

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

Browse Source 
Updates the API doc for GET /streams/{stream_id}/members 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:00:34 +02:00
committed by Tim Abbott
parent dfc6eab8a0
commit 2b71875676
1 changed files with 5 additions and 5 deletions
Download Patch File Download Diff File Expand all files Collapse all files

10
zerver/openapi/zulip.yaml
View File

@@ -17857,10 +17857,10 @@ paths:
/streams/{stream_id}/members:
get:
operationId: get-subscribers
summary: Get the subscribers of a stream
summary: Get the subscribers of a channel
tags: ["streams"]
description: |
Get all users subscribed to a stream.
Get all users subscribed to a channel.
parameters:
- $ref: "#/components/parameters/ChannelIdInPath"
responses:
@@ -17882,7 +17882,7 @@ paths:
type: integer
description: |
A list containing the IDs of all active users who are subscribed
to the stream.
to the channel.
example:
{"result": "success", "msg": "", "subscribers": [11, 26]}
"400":
@@ -17893,8 +17893,8 @@ paths:
allOf:
- $ref: "#/components/schemas/InvalidChannelError"
- description: |
An example JSON response for when the requested stream does not exist,
or where the user does not have permission to access the target stream:
An example JSON response for when the requested channel does not exist,
or where the user does not have permission to access the target channel:
/streams:
get:
operationId: get-streams