From 23a25c1c3d2a6b9a5b8220a5ac517246838cf458 Mon Sep 17 00:00:00 2001 From: juancarmore Date: Fri, 23 Jan 2026 19:12:48 +0100 Subject: [PATCH] openapi: add error response for empty ZIP download and update recordings and rooms notes --- ...om.yaml => error-recordings-zip-empty.yaml} | 4 ++-- meet-ce/backend/openapi/paths/recordings.yaml | 18 +++++++++--------- meet-ce/backend/openapi/paths/rooms.yaml | 3 +++ 3 files changed, 14 insertions(+), 11 deletions(-) rename meet-ce/backend/openapi/components/responses/{error-recordings-not-same-room.yaml => error-recordings-zip-empty.yaml} (50%) diff --git a/meet-ce/backend/openapi/components/responses/error-recordings-not-same-room.yaml b/meet-ce/backend/openapi/components/responses/error-recordings-zip-empty.yaml similarity index 50% rename from meet-ce/backend/openapi/components/responses/error-recordings-not-same-room.yaml rename to meet-ce/backend/openapi/components/responses/error-recordings-zip-empty.yaml index 3e88c24d..3efa9b88 100644 --- a/meet-ce/backend/openapi/components/responses/error-recordings-not-same-room.yaml +++ b/meet-ce/backend/openapi/components/responses/error-recordings-zip-empty.yaml @@ -1,8 +1,8 @@ -description: Recordings not from the same room +description: Recordings not available for ZIP download content: application/json: schema: $ref: ../schemas/error.yaml example: error: 'Recording Error' - message: 'None of the provided recording IDs belong to room "room123"' + message: 'None of the provided recordings are available for ZIP download' diff --git a/meet-ce/backend/openapi/paths/recordings.yaml b/meet-ce/backend/openapi/paths/recordings.yaml index a1ebeac0..7ac5da99 100644 --- a/meet-ce/backend/openapi/paths/recordings.yaml +++ b/meet-ce/backend/openapi/paths/recordings.yaml @@ -9,8 +9,8 @@ By default, the recordings are sorted by start date in descending order (newest first). > **Note:** - > - When using `accessTokenHeader` authentication: Returns only recordings the authenticated user has access to. - > - When using `roomMemberTokenHeader` authentication: The `roomId` filter is ignored and only recordings associated with the room included in the token are returned. + > - When using `accessTokenHeader` authentication: Only recordings the authenticated user has access to will be returned. + > - When using `roomMemberTokenHeader` authentication: The `roomId` filter is ignored and only recordings associated with the room included in the token will be returned. tags: - OpenVidu Meet - Recordings security: @@ -44,9 +44,9 @@ description: | Deletes multiple recordings at once with the specified recording IDs. - > **Note:** If this endpoint is called using the `roomMemberTokenHeader` authentication method, - > all specified recordings must belong to the same room included in the token. - > If a recording does not belong to that room, it will not be deleted. + > **Note:** + > - When using `accessTokenHeader` authentication: Only deletes recordings the authenticated user has access to. + > - When using `roomMemberTokenHeader` authentication: Only deletes recordings associated with the room included in the token. tags: - OpenVidu Meet - Recordings security: @@ -77,9 +77,9 @@ Downloads multiple recordings as a ZIP file with the specified recording IDs. The ZIP file will contain all recordings in MP4 format. - > **Note:** If this endpoint is called using the `roomMemberTokenHeader` authentication method, - > all specified recordings must belong to the same room included in the token. - > If a recording does not belong to that room, it will not be included in the ZIP file. + > **Note:** + > - When using `accessTokenHeader` authentication: Only includes recordings the authenticated user has access to. + > - When using `roomMemberTokenHeader` authentication: Only includes recordings associated with the room included in the token. tags: - OpenVidu Meet - Recordings security: @@ -105,7 +105,7 @@ type: string format: binary '400': - $ref: '../components/responses/error-recordings-not-same-room.yaml' + $ref: '../components/responses/error-recordings-zip-empty.yaml' '401': $ref: '../components/responses/unauthorized-error.yaml' '403': diff --git a/meet-ce/backend/openapi/paths/rooms.yaml b/meet-ce/backend/openapi/paths/rooms.yaml index 0a08c123..d2b13dc7 100644 --- a/meet-ce/backend/openapi/paths/rooms.yaml +++ b/meet-ce/backend/openapi/paths/rooms.yaml @@ -69,6 +69,9 @@ Depending on these policies, the rooms may be deleted/closed immediately, scheduled to be deleted/closed once the meetings end, or the operation may fail if deletion is not permitted. + + > **Note:** If this endpoint is called using the `accessTokenHeader` authentication method, + > only rooms the authenticated user can manage will be deleted. tags: - OpenVidu Meet - Rooms security: