openapi: update recording access options and enhance descriptions

This commit is contained in:
juancarmore 2025-06-13 17:19:00 +02:00
parent acd9a4c880
commit 615199edb8
2 changed files with 10 additions and 2 deletions

View File

@ -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:

View File

@ -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: