paulmataruso/zulip
1
0
Fork 0
mirror of https://github.com/zulip/zulip.git synced 2025-11-04 05:53:43 +00:00
Code Issues Packages Projects Releases Wiki Activity

api-docs: Revise folder_id parameter for adding/updating channels.

Browse Source 
Revises the description of the `folder_id` parameters in the
api/create-channel, api/subscribe and api/update-stream endpoints.
This commit is contained in:
Lauryn Menard
2025-08-28 15:26:43 +02:00
committed by Tim Abbott
parent 2660c876fa
commit 224499b58f
1 changed files with 13 additions and 9 deletions
Download Patch File Download Diff File Expand all files Collapse all files

22
zerver/openapi/zulip.yaml
View File

@@ -12109,11 +12109,8 @@ paths:
$ref: "#/components/schemas/CanResolveTopicsGroup" $ref: "#/components/schemas/CanResolveTopicsGroup"
folder_id: folder_id:
description: | description: |
This parameter determines the folder to which the newly This parameter adds the newly created channel to the specified
created channel will be added. [channel folder](/help/channel-folders).
If the value is `None`, the channel will not be added to
any folder.
**Changes**: New in Zulip 11.0 (feature level 389). **Changes**: New in Zulip 11.0 (feature level 389).
type: integer type: integer
@@ -22889,10 +22886,11 @@ paths:
example: true example: true
folder_id: folder_id:
description: | description: |
ID of the new folder to which the channel should belong. ID of the new [channel folder](/help/channel-folders) to which the
channel should belong.
It can be `None` if the user wants to just remove the channel A `null` value indicates the user wants to remove the channel from its
from its existing folder. current channel folder.
**Changes**: New in Zulip 11.0 (feature level 389). **Changes**: New in Zulip 11.0 (feature level 389).
type: integer type: integer
@@ -23729,7 +23727,13 @@ paths:
default: false default: false
example: true example: true
folder_id: folder_id:
$ref: "#/components/schemas/FolderId" description: |
This parameter adds the newly created channel to the specified
[channel folder](/help/channel-folders).
**Changes**: New in Zulip 11.0 (feature level 389).
type: integer
example: 1
topics_policy: topics_policy:
$ref: "#/components/schemas/TopicsPolicy" $ref: "#/components/schemas/TopicsPolicy"
history_public_to_subscribers: history_public_to_subscribers: