From a7c4b84a0326180fee20e4c0a6cb934acc55d32d Mon Sep 17 00:00:00 2001
From: Carlos Santos <4a.santos@gmail.com>
Date: Mon, 17 Mar 2025 17:08:23 +0100
Subject: [PATCH] backend: Enhance OpenAPI spec for recordings API with
 pagination support

---
 backend/openapi/openvidu-meet-api.yaml | 52 ++++++++++++++++++++------
 1 file changed, 41 insertions(+), 11 deletions(-)

diff --git a/backend/openapi/openvidu-meet-api.yaml b/backend/openapi/openvidu-meet-api.yaml
index 2fd3822..7ada585 100644
--- a/backend/openapi/openvidu-meet-api.yaml
+++ b/backend/openapi/openvidu-meet-api.yaml
@@ -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: