neoris/openvidu
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

openapi: add recording token generation endpoint and associated API responses; add recordingTokenCookie authentication method to recording endpoints

Browse Source
This commit is contained in:
juancarmore 2025-05-15 21:59:38 +02:00
parent 20bba0b886
commit 2b7e2ecf7e
12 changed files with 104 additions and 10 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

6
backend/openapi/components/headers/set-cookie-recording-token.yaml Normal file
View File

@ -0,0 +1,6 @@
description: >
The cookie containing the recording token.
This cookie is used to access the recordings in a room.
schema:
type: string
example: 'OvMeetRecordingToken=token_123456; Path=/; HttpOnly; SameSite=Strict'

10
backend/openapi/components/requestBodies/internal/recording-token-request.yaml Normal file
View File

@ -0,0 +1,10 @@
description: Room secret
required: true
content:
application/json:
schema:
type: object
properties:
secret:
type: string
description: The secret value from the room URL used to connect to the room.

8
backend/openapi/components/responses/internal/error-participant-not-found.yaml
View File

@ -1,8 +0,0 @@
description: Participant not found
content:
application/json:
schema:
$ref: '../../schemas/error.yaml'
example:
error: 'Participant Error'
message: 'Participant "Alice" not found in room "room_123"'

8
backend/openapi/components/responses/internal/error-room-metadata-not-found.yaml Normal file
View File

@ -0,0 +1,8 @@
description: Room metadata not found
content:
application/json:
schema:
$ref: '../../schemas/error.yaml'
example:
error: 'Room Error'
message: 'Room metadata for "room_123" not found. Room "room_123" does not exist or has no recordings associated'

16
backend/openapi/components/responses/internal/error-room-participant-not-found.yaml Normal file
View File

@ -0,0 +1,16 @@
description: Room or participant not found
content:
application/json:
schema:
$ref: '../../schemas/error.yaml'
examples:
participant_not_found:
summary: Participant not found
value:
error: 'Participant Error'
message: 'Participant "Alice" not found in room "room_123"'
room_not_found:
summary: Room not found
value:
error: 'Room Error'
message: 'Room "room_123" not found'

13
backend/openapi/components/responses/internal/success-generate-recording-token.yaml Normal file
View File

@ -0,0 +1,13 @@
description: Successfully generated the recording token
headers:
Set-Cookie:
$ref: '../../headers/set-cookie-recording-token.yaml'
content:
application/json:
schema:
type: object
properties:
token:
type: string
description: >
The token to access the recordings in the specified OpenVidu Meet room.

6
backend/openapi/components/security.yaml
View File

@ -22,3 +22,9 @@ participantTokenCookie:
in: cookie
description: >
The JWT token to authenticate the participant when entering the room.
recordingTokenCookie:
type: apiKey
name: OvMeetRecordingToken
in: cookie
description: >
The JWT token containing permissions to access the recordings in a room.

2
backend/openapi/openvidu-meet-internal-api.yaml
View File

@ -18,6 +18,8 @@ paths:
$ref: './paths/internal/auth.yaml#/~1auth~1profile'
/rooms/{roomId}:
$ref: './paths/internal/rooms.yaml#/~1rooms~1{roomId}'
/rooms/{roomId}/recording-token:
$ref: './paths/internal/rooms.yaml#/~1rooms~1{roomId}~1recording-token'
/rooms/{roomId}/roles:
$ref: './paths/internal/rooms.yaml#/~1rooms~1{roomId}~1roles'
/rooms/{roomId}/roles/{secret}:

2
backend/openapi/paths/internal/meetings.yaml
View File

@ -44,6 +44,6 @@
'403':
$ref: '../../components/responses/forbidden-error.yaml'
'404':
$ref: '../../components/responses/internal/error-participant-not-found.yaml'
$ref: '../../components/responses/internal/error-room-participant-not-found.yaml'
'500':
$ref: '../../components/responses/internal-server-error.yaml'

6
backend/openapi/paths/internal/participants.yaml
View File

@ -23,6 +23,8 @@
$ref: '../../components/responses/error-room-not-found.yaml'
'409':
$ref: '../../components/responses/internal/error-participant-already-exists.yaml'
'422':
$ref: '../../components/responses/validation-error.yaml'
'500':
$ref: '../../components/responses/internal-server-error.yaml'
/participants/token/refresh:
@ -47,8 +49,10 @@
'403':
$ref: '../../components/responses/forbidden-error.yaml'
'404':
$ref: '../../components/responses/error-room-not-found.yaml'
$ref: '../../components/responses/internal/error-room-participant-not-found.yaml'
'409':
$ref: '../../components/responses/internal/error-participant-token-still-valid.yaml'
'422':
$ref: '../../components/responses/validation-error.yaml'
'500':
$ref: '../../components/responses/internal-server-error.yaml'

30
backend/openapi/paths/internal/rooms.yaml
View File

@ -25,6 +25,36 @@
$ref: '../../components/responses/validation-error.yaml'
'500':
$ref: '../../components/responses/internal-server-error.yaml'
/rooms/{roomId}/recording-token:
post:
operationId: generateRecordingToken
summary: Generate recording token
description: >
Generates a token with recording permissions for a specified OpenVidu Meet room.
This token can be used to access the recordings in a room.
tags:
- Internal API - Rooms
security:
- accessTokenCookie: []
parameters:
- $ref: '../../components/parameters/room-id-path.yaml'
requestBody:
$ref: '../../components/requestBodies/internal/recording-token-request.yaml'
responses:
'200':
$ref: '../../components/responses/internal/success-generate-recording-token.yaml'
'400':
$ref: '../../components/responses/internal/error-invalid-room-secret.yaml'
'401':
$ref: '../../components/responses/unauthorized-error.yaml'
'403':
$ref: '../../components/responses/forbidden-error.yaml'
'404':
$ref: '../../components/responses/internal/error-room-metadata-not-found.yaml'
'422':
$ref: '../../components/responses/validation-error.yaml'
'500':
$ref: '../../components/responses/internal-server-error.yaml'
/rooms/{roomId}/roles:
get:
operationId: getRoomRolesAndPermissions

7
backend/openapi/paths/recordings.yaml
View File

@ -5,11 +5,15 @@
description: >
Retrieves a paginated list of all recordings available in the system.
You can apply filters to narrow down the results based on specific criteria.
> **Note:** If this endpoint is called using the `recordingTokenCookie` authentication method,
the `roomId` filter will be ignored and only recordings associated with the room included in the token will be returned.
tags:
- OpenVidu Meet - Recordings
security:
- apiKeyInHeader: []
- accessTokenCookie: []
- recordingTokenCookie: []
parameters:
# - name: status
# in: query
@ -90,6 +94,7 @@
security:
- apiKeyInHeader: []
- accessTokenCookie: []
- recordingTokenCookie: []
parameters:
- $ref: '../components/parameters/recording-id.yaml'
responses:
@ -116,6 +121,7 @@
security:
- apiKeyInHeader: []
- accessTokenCookie: []
- recordingTokenCookie: []
parameters:
- $ref: '../components/parameters/recording-id.yaml'
responses:
@ -147,6 +153,7 @@
security:
- apiKeyInHeader: []
- accessTokenCookie: []
- recordingTokenCookie: []
parameters:
- $ref: '../components/parameters/recording-id.yaml'
- $ref: '../components/parameters/recording-range.yaml'