paulmataruso/zulip
1
0
Fork 0
mirror of https://github.com/zulip/zulip.git synced 2025-10-25 00:53:56 +00:00
Code Issues Packages Projects Releases Wiki Activity

api: Increment API feature level to 389.

Browse Source
This commit is contained in:
Tim Abbott
2025-05-20 12:54:56 -07:00
parent 222ccac765
commit 30866ce562
9 changed files with 36 additions and 37 deletions
Download Patch File Download Diff File Expand all files Collapse all files

25
api_docs/changelog.md
View File

@@ -20,6 +20,31 @@ format used by the Zulip server that they are interacting with.
## Changes in Zulip 11.0
**Feature level 389**
* [`POST /channel_folders/create`](/api/create-channel-folder): Added
a new endpoint for creating a new channel folder.
* [`GET /channel_folders`](/api/get-channel-folders): Added a new endpoint
to get all channel folders in the realm.
* [`PATCH /channel_folders/{channel_folder_id}`](/api/update-channel-folder):
Added a new endpoint to update channel folder.
* [`POST /register`](/api/register-queue): Added `channel_folders` field to
response.
* [`GET /events`](/api/get-events): An event with `type: "channel_folder"` is
sent to all users when a channel folder is created.
* [`GET /users/me/subscriptions`](/api/get-subscriptions),
[`GET /streams`](/api/get-streams), [`GET /events`](/api/get-events),
[`POST /register`](/api/register-queue): Added `folder_id` field
to Stream and Subscription objects.
* [`POST /users/me/subscriptions`](/api/subscribe): Added support to add
newly created channels to folder using `folder_id` parameter.
* [`PATCH /streams/{stream_id}`](/api/update-stream): Added support
for updating folder to which the channel belongs.
* [`GET /events`](/api/get-events): An event with `type: "channel_folder"` is
sent to all users when a channel folder is updated.
* [`GET /events`](/api/get-events): `value` field in `stream/update`
events can have `null` when channel is removed from a folder.
**Feature level 388**
* [`PATCH /streams/{stream_id}`](/api/update-stream): Added

2
api_docs/unmerged.d/ZF-2a4adb.md
View File

@@ -1,2 +0,0 @@
* [`GET /channel_folders`](/api/get-channel-folders): Added a new endpoint
to get all channel folders in the realm.

4
api_docs/unmerged.d/ZF-2f0879.md
View File

@@ -1,4 +0,0 @@
* [`GET /users/me/subscriptions`](/api/get-subscriptions),
[`GET /streams`](/api/get-streams), [`GET /events`](/api/get-events),
[`POST /register`](/api/register-queue): Added `folder_id` field
to Stream and Subscription objects.

8
api_docs/unmerged.d/ZF-392de9.md
View File

@@ -1,8 +0,0 @@
* [`POST /channel_folders/create`](/api/create-channel-folder): Added
a new endpoint for creating a new channel folder.
* [`GET /events`](/api/get-events): An event with `type: "channel_folder"` is
sent to all users when a channel folder is created.
* [`POST /register`](/api/register-queue): Added `channel_folders` field to
response.

5
api_docs/unmerged.d/ZF-57cda6.md
View File

@@ -1,5 +0,0 @@
* [`PATCH /streams/{stream_id}`](/api/update-stream): Added support for updating
folder to which the channel belongs.
* [`GET /events`](/api/get-events): `value` field in `stream/update` events can
have `null` when channel is removed from a folder.

5
api_docs/unmerged.d/ZF-7b788e.md
View File

@@ -1,5 +0,0 @@
* [`PATCH /channel_folders/{channel_folder_id}`](/api/update-channel-folder):
Added a new endpoint to update channel folder.
* [`GET /events`](/api/get-events): An event with `type: "channel_folder"` is
sent to all users when a channel folder is updated.

2
api_docs/unmerged.d/ZF-919531.md
View File

@@ -1,2 +0,0 @@
* [`POST /users/me/subscriptions`](/api/subscribe): Added support to add
newly created channels to folder using `folder_id` parameter.

2
version.py
View File

@@ -34,7 +34,7 @@ DESKTOP_WARNING_VERSION = "5.9.3"
# new level means in api_docs/changelog.md, as well as "**Changes**"
# entries in the endpoint's documentation in `zulip.yaml`.
API_FEATURE_LEVEL = 388
API_FEATURE_LEVEL = 389
# Bump the minor PROVISION_VERSION to indicate that folks should provision
# only when going from an old version of the code to a newer version. Bump

20
zerver/openapi/zulip.yaml
View File

@@ -1495,7 +1495,7 @@ paths:
description: |
The new value of the changed property.
**Changes**: Starting with Zulip 11.0 (feature level ZF-57cda6),
**Changes**: Starting with Zulip 11.0 (feature level 389),
this value can be `null` when a channel is removed from the folder.
Starting with Zulip 10.0 (feature level 320), this
@@ -5727,7 +5727,7 @@ paths:
description: |
Event sent to users in an organization when a channel folder is created.
**Changes**: New in Zulip 11.0 (feature level ZF-392de9).
**Changes**: New in Zulip 11.0 (feature level 389).
properties:
id:
$ref: "#/components/schemas/EventIdSchema"
@@ -5763,7 +5763,7 @@ paths:
description: |
Event sent to users in an organization when a channel folder is updated.
**Changes**: New in Zulip 11.0 (feature level ZF-7b788e).
**Changes**: New in Zulip 11.0 (feature level 389).
properties:
id:
$ref: "#/components/schemas/EventIdSchema"
@@ -11231,7 +11231,7 @@ paths:
If the value is `None`, the channel will not be added to
any folder.
**Changes**: New in Zulip 11.0 (feature level ZF-919531).
**Changes**: New in Zulip 11.0 (feature level 389).
type: integer
example: 1
required:
@@ -15918,7 +15918,7 @@ paths:
Only channel folders with one or more public web channels are
visible to spectators.
**Changes**: New in Zulip 11.0 (feature level ZF-392de9).
**Changes**: New in Zulip 11.0 (feature level 389).
unread_msgs:
type: object
description: |
@@ -21386,7 +21386,7 @@ paths:
It can be `None` if the user wants to just remove the channel
from its existing folder.
**Changes**: New in Zulip 11.0 (feature level ZF-57cda6).
**Changes**: New in Zulip 11.0 (feature level 389).
type: integer
nullable: true
example: 1
@@ -22976,7 +22976,7 @@ paths:
Only organization administrators can create a new channel
folder.
**Changes**: New in Zulip 11.0 (feature level ZF-392de9).
**Changes**: New in Zulip 11.0 (feature level 389).
requestBody:
required: true
content:
@@ -23042,7 +23042,7 @@ paths:
description: |
Fetches all of the channel folders in the organization.
**Changes**: New in Zulip 11.0 (feature level ZF-2a4adb).
**Changes**: New in Zulip 11.0 (feature level 389).
requestBody:
required: false
content:
@@ -23118,7 +23118,7 @@ paths:
Only organization administrators can update a
channel folder.
**Changes**: New in Zulip 11.0 (feature level ZF-7b788e).
**Changes**: New in Zulip 11.0 (feature level 389).
parameters:
- $ref: "#/components/parameters/ChannelFolderId"
requestBody:
@@ -26636,7 +26636,7 @@ components:
Is `null` if channel does not belong to any folder.
**Changes**: New in Zulip 11.0 (feature level ZF-2f0879).
**Changes**: New in Zulip 11.0 (feature level 389).
###################
# Shared responses