openapi: update recording access options and enhance descriptions
This commit is contained in:
parent
acd9a4c880
commit
615199edb8
@ -32,9 +32,13 @@ MeetRecordingPreferences:
|
|||||||
- admin
|
- admin
|
||||||
- admin-moderator
|
- admin-moderator
|
||||||
- admin-moderator-publisher
|
- admin-moderator-publisher
|
||||||
- public
|
|
||||||
default: admin-moderator-publisher
|
default: admin-moderator-publisher
|
||||||
example: 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:
|
MeetVirtualBackgroundPreferences:
|
||||||
type: object
|
type: object
|
||||||
properties:
|
properties:
|
||||||
|
|||||||
@ -100,6 +100,8 @@
|
|||||||
responses:
|
responses:
|
||||||
'200':
|
'200':
|
||||||
$ref: '../components/responses/success-get-recording.yaml'
|
$ref: '../components/responses/success-get-recording.yaml'
|
||||||
|
'400':
|
||||||
|
$ref: '../components/responses/error-invalid-recording-secret.yaml'
|
||||||
'401':
|
'401':
|
||||||
$ref: '../components/responses/unauthorized-error.yaml'
|
$ref: '../components/responses/unauthorized-error.yaml'
|
||||||
'403':
|
'403':
|
||||||
@ -218,7 +220,9 @@
|
|||||||
summary: Get recording URL
|
summary: Get recording URL
|
||||||
description: >
|
description: >
|
||||||
Retrieves the URL of a recording with the specified recording ID.
|
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:
|
tags:
|
||||||
- OpenVidu Meet - Recordings
|
- OpenVidu Meet - Recordings
|
||||||
security:
|
security:
|
||||||
|
|||||||
Loading…
x
Reference in New Issue
Block a user