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

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

@ -459,7 +459,7 @@ paths:
operationId: getRecordings operationId: getRecordings
summary: Get a list of OpenVidu Meet recordings summary: Get a list of OpenVidu Meet recordings
description: > description: >
Retrieves a list of OpenVidu Meet recordings. Retrieves a paginated list of OpenVidu Meet recordings
tags: tags:
- OpenVidu Meet - Recordings - OpenVidu Meet - Recordings
security: security:
@ -472,15 +472,45 @@ paths:
The status of the recordings to retrieve. Possible values are "STARTING", "STARTED", "STOPPING", "STOPPED", "FAILED" and "READY". The status of the recordings to retrieve. Possible values are "STARTING", "STARTED", "STOPPING", "STOPPED", "FAILED" and "READY".
schema: schema:
type: string 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: responses:
'200': '200':
description: Successfully retrieved the list of OpenVidu Meet recordings description: Successfully retrieved the list of OpenVidu Meet recordings
content: content:
application/json: application/json:
schema: schema:
type: object
properties:
recordings:
type: array type: array
items: items:
$ref: '#/components/schemas/OpenViduMeetRecording' $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': '401':
description: Unauthorized — The API key is missing or invalid description: Unauthorized — The API key is missing or invalid
content: content: