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

backend: Enhance OpenAPI spec for recordings API with pagination support

Browse Source
This commit is contained in:
Carlos Santos 2025-03-17 17:08:23 +01:00
parent fee592cadf
commit a7c4b84a03
1 changed files with 41 additions and 11 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

52
backend/openapi/openvidu-meet-api.yaml
View File

@ -459,28 +459,58 @@ paths:
operationId: getRecordings
summary: Get a list of OpenVidu Meet recordings
description: >
Retrieves a list of OpenVidu Meet recordings.
Retrieves a paginated list of OpenVidu Meet recordings
tags:
- OpenVidu Meet - Recordings
security:
- apiKeyInHeader: []
parameters:
- name: status
in: query
required: false
description: |
The status of the recordings to retrieve. Possible values are "STARTING", "STARTED", "STOPPING", "STOPPED", "FAILED" and "READY".
schema:
type: string
- name: status
in: query
required: false
description: |
The status of the recordings to retrieve. Possible values are "STARTING", "STARTED", "STOPPING", "STOPPED", "FAILED" and "READY".
schema:
type: string
- name: page
in: query
required: false
description: The page number for pagination (default is 1).
schema:
type: integer
default: 1
- name: limit
in: query
required: false
description: The number of recordings per page (default is 10). Maximum is 100.
schema:
type: integer
default: 10
responses:
'200':
description: Successfully retrieved the list of OpenVidu Meet recordings
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/OpenViduMeetRecording'
type: object
properties:
recordings:
type: array
items:
$ref: '#/components/schemas/OpenViduMeetRecording'
pagination:
type: object
properties:
totalItems:
type: integer
description: Total number of recordings.
totalPages:
type: integer
description: Total number of pages.
currentPage:
type: integer
description: Current page number.
'401':
description: Unauthorized — The API key is missing or invalid
content: