From 615199edb8a7d6c58b953bbaa4bdf08ae4a0a080 Mon Sep 17 00:00:00 2001 From: juancarmore Date: Fri, 13 Jun 2025 17:19:00 +0200 Subject: [PATCH] openapi: update recording access options and enhance descriptions --- .../openapi/components/schemas/meet-room-preferences.yaml | 6 +++++- backend/openapi/paths/recordings.yaml | 6 +++++- 2 files changed, 10 insertions(+), 2 deletions(-) diff --git a/backend/openapi/components/schemas/meet-room-preferences.yaml b/backend/openapi/components/schemas/meet-room-preferences.yaml index ec7d432..6ecfecd 100644 --- a/backend/openapi/components/schemas/meet-room-preferences.yaml +++ b/backend/openapi/components/schemas/meet-room-preferences.yaml @@ -32,9 +32,13 @@ MeetRecordingPreferences: - admin - admin-moderator - admin-moderator-publisher - - public default: admin-moderator-publisher example: admin-moderator-publisher + description: | + Defines who can access the recording. Options are: + - `admin`: Only administrators can access the recording. + - `admin-moderator`: Administrators and moderators can access the recording. + - `admin-moderator-publisher`: Administrators, moderators and publishers can access the recording. MeetVirtualBackgroundPreferences: type: object properties: diff --git a/backend/openapi/paths/recordings.yaml b/backend/openapi/paths/recordings.yaml index 7e6202c..96adaf5 100644 --- a/backend/openapi/paths/recordings.yaml +++ b/backend/openapi/paths/recordings.yaml @@ -100,6 +100,8 @@ responses: '200': $ref: '../components/responses/success-get-recording.yaml' + '400': + $ref: '../components/responses/error-invalid-recording-secret.yaml' '401': $ref: '../components/responses/unauthorized-error.yaml' '403': @@ -218,7 +220,9 @@ summary: Get recording URL description: > Retrieves the URL of a recording with the specified recording ID. - This URL can be used to access the recording media directly. + This URL is intended to be shared with people who do not have direct access to the recording. + It can be configured to be accessible by anyone (public access) or restricted to authenticated users only, + depending on the `privateAccess` query parameter. tags: - OpenVidu Meet - Recordings security: