api-docs: Revise descriptive text in channel folders endpoints.

Adds links to relevant help center documentation on channel
folders.

(cherry picked from commit 1d99e55bb4)
This commit is contained in:
Lauryn Menard
2025-08-13 16:48:44 +02:00
committed by Tim Abbott
parent 28a37f82fa
commit dbee13e75c

View File

@@ -24957,8 +24957,7 @@ paths:
tags: ["channels"] tags: ["channels"]
x-requires-administrator: true x-requires-administrator: true
description: | description: |
Create a new channel folder, that will be used to organize Create a new [channel folder](/help/channel-folders).
channels in left sidebar.
**Changes**: New in Zulip 11.0 (feature level 389). **Changes**: New in Zulip 11.0 (feature level 389).
requestBody: requestBody:
@@ -25036,11 +25035,11 @@ paths:
summary: Get channel folders summary: Get channel folders
tags: ["channels"] tags: ["channels"]
description: | description: |
Fetches all of the channel folders in the organization. Fetches all of the [channel folders](/help/channel-folders) in the
The folders are sorted by the `order` field. organization, sorted by the `order` field.
**Changes**: Before Zulip 11.0 (feature level 414), **Changes**: Before Zulip 11.0 (feature level 414), the list of channel
these were sorted by ID. (The `order` field didn't exist). folders was sorted by ID as the `order` field didn't exist.
New in Zulip 11.0 (feature level 389). New in Zulip 11.0 (feature level 389).
requestBody: requestBody:
@@ -25110,9 +25109,14 @@ paths:
tags: ["channels"] tags: ["channels"]
x-requires-administrator: true x-requires-administrator: true
description: | description: |
Given an array of channel folder IDs, this method will set the `order` Reorder the [channel folders](/help/channel-folders) in the user's
property of all of the channel folders in the organization according to organization.
the order of the channel folder IDs specified in the request.
Channel folders are displayed in Zulip UI in order; this endpoint allows
administrative settings UI to change the ordering of channel folders.
This endpoint is used to implement the dragging feature described in the
[manage channel folders documentation](/help/manage-channel-folders).
**Changes**: New in Zulip 11.0 (feature level 414). **Changes**: New in Zulip 11.0 (feature level 414).
requestBody: requestBody:
@@ -25127,9 +25131,8 @@ paths:
description: | description: |
A list of channel folder IDs representing the new order. A list of channel folder IDs representing the new order.
This list must include the IDs of all the This list must include the IDs of [all the organization's channel
organization's channel folders, including archived folders](/api/get-channel-folders), including archived folders.
folders.
items: items:
type: integer type: integer
example: [2, 1] example: [2, 1]
@@ -25165,10 +25168,11 @@ paths:
tags: ["channels"] tags: ["channels"]
x-requires-administrator: true x-requires-administrator: true
description: | description: |
Update the name or description of a channel folder. Update the name or description of a [channel folder](/help/channel-folders)
with the specified ID.
This endpoint is also used to archive and unarchive This endpoint is also used to archive or unarchive the specified channel
a channel folder. folder.
**Changes**: New in Zulip 11.0 (feature level 389). **Changes**: New in Zulip 11.0 (feature level 389).
parameters: parameters:
@@ -28171,10 +28175,23 @@ components:
description: | description: |
Object containing the channel folder's attributes. Object containing the channel folder's attributes.
properties: properties:
id:
type: integer
description: |
The unique ID of the channel folder.
name: name:
type: string type: string
description: | description: |
The name of the channel folder. The name of the channel folder.
order:
type: integer
description: |
This value determines in which order the channel folder should be
displayed in the UI. The value is 0 indexed, and a channel folder with
a lower value should be displayed before channel folders with higher
values.
**Changes**: New in Zulip 11.0 (feature level 414).
date_created: date_created:
type: integer type: integer
nullable: true nullable: true
@@ -28185,37 +28202,25 @@ components:
type: integer type: integer
nullable: true nullable: true
description: | description: |
The ID of the user who created this channel folder. The ID of the user who created the channel folder.
description: description:
type: string type: string
description: | description: |
The description of the channel folder. The description of the channel folder. Can be an empty string.
See [Markdown message formatting](/api/message-formatting) for details on Zulip's HTML format. See [Markdown message formatting](/api/message-formatting) for details
on Zulip's HTML format.
rendered_description: rendered_description:
type: string type: string
description: | description: |
The description of the channel folder rendered as HTML, The description of the channel folder rendered as HTML, intended to be
intended to be used when displaying the channel folder used for UI that displays the channel folder description.
description in a UI.
One should use the standard Zulip rendered_markdown CSS when Clients should use the standard Zulip rendered_markdown CSS when
displaying this content so that emoji, LaTeX, and other syntax displaying this content so that emoji, LaTeX, and other syntax work
work correctly. And any client-side security logic for correctly. And any client-side security logic for user-generated
user-generated message content should be applied when displaying message content should be applied when displaying this HTML as though
this HTML as though it were the body of a Zulip message. it were the body of a Zulip message.
order:
type: integer
description: |
This value determines in which order the channel folders will be
displayed in the UI. The value is 0 indexed, and the value with
the lower order will be displayed first.
**Changes**: New in Zulip 11.0 (feature level 414).
id:
type: integer
description: |
The ID of the channel folder.
is_archived: is_archived:
type: boolean type: boolean
description: | description: |