api-docs: Add admin only notes for channel folder endpoints.

(cherry picked from commit 4b7e0be1ab)
This commit is contained in:
Lauryn Menard
2025-08-13 12:55:07 +02:00
committed by Tim Abbott
parent 738b3e9399
commit 6a318bd2ef

View File

@@ -24955,13 +24955,11 @@ paths:
operationId: create-channel-folder
summary: Create a channel folder
tags: ["channels"]
x-requires-administrator: true
description: |
Create a new channel folder, that will be used to organize
channels in left sidebar.
Only organization administrators can create a new channel
folder.
**Changes**: New in Zulip 11.0 (feature level 389).
requestBody:
required: true
@@ -25106,6 +25104,7 @@ paths:
operationId: patch-channel-folders
summary: Reorder channel folders
tags: ["channels"]
x-requires-administrator: true
description: |
Given an array of channel folder IDs, this method will set the `order`
property of all of the channel folders in the organization according to
@@ -25157,15 +25156,13 @@ paths:
operationId: update-channel-folder
summary: Update a channel folder
tags: ["channels"]
x-requires-administrator: true
description: |
Update the name or description of a channel folder.
This endpoint is also used to archive and unarchive
a channel folder.
Only organization administrators can update a
channel folder.
**Changes**: New in Zulip 11.0 (feature level 389).
parameters:
- $ref: "#/components/parameters/ChannelFolderId"