From 09516d3042d13b7f55dcea8664c6bbd39bb4880f Mon Sep 17 00:00:00 2001
From: juancarmore <juancar_more2@hotmail.com>
Date: Tue, 10 Jun 2025 15:37:55 +0200
Subject: [PATCH] openapi: add recording secret parameter and fix some typos

---
 .../openapi/components/parameters/recording-secret.yaml    | 6 ++++++
 .../requestBodies/internal/change-password-request.yaml    | 7 ++++---
 .../responses/error-invalid-recording-secret.yaml          | 2 +-
 backend/openapi/openvidu-meet-api.yaml                     | 2 +-
 backend/openapi/paths/recordings.yaml                      | 3 ++-
 5 files changed, 14 insertions(+), 6 deletions(-)
 create mode 100644 backend/openapi/components/parameters/recording-secret.yaml

diff --git a/backend/openapi/components/parameters/recording-secret.yaml b/backend/openapi/components/parameters/recording-secret.yaml
new file mode 100644
index 0000000..811b115
--- /dev/null
+++ b/backend/openapi/components/parameters/recording-secret.yaml
@@ -0,0 +1,6 @@
+name: secret
+in: query
+required: false
+description: The secret value used to access the recording when sharing a recording link.
+schema:
+    type: string
diff --git a/backend/openapi/components/requestBodies/internal/change-password-request.yaml b/backend/openapi/components/requestBodies/internal/change-password-request.yaml
index ba02ae8..fe06946 100644
--- a/backend/openapi/components/requestBodies/internal/change-password-request.yaml
+++ b/backend/openapi/components/requestBodies/internal/change-password-request.yaml
@@ -1,10 +1,11 @@
-description: New password
+description: New password request
 required: true
 content:
     application/json:
         schema:
             type: object
             properties:
-                secret:
-                    type: newPassword
+                newPassword:
+                    type: string
                     description: The new password for the user.
+                    example: "newSecurePassword123"
diff --git a/backend/openapi/components/responses/error-invalid-recording-secret.yaml b/backend/openapi/components/responses/error-invalid-recording-secret.yaml
index de476db..9308632 100644
--- a/backend/openapi/components/responses/error-invalid-recording-secret.yaml
+++ b/backend/openapi/components/responses/error-invalid-recording-secret.yaml
@@ -2,7 +2,7 @@ description: Invalid recording secret
 content:
     application/json:
         schema:
-            $ref: ../../schemas/error.yaml
+            $ref: ../schemas/error.yaml
         example:
             error: 'Recording Error'
             message: 'Secret "123456" is not recognized for recording "room-123--EG_XYZ--XX445"'
\ No newline at end of file
diff --git a/backend/openapi/openvidu-meet-api.yaml b/backend/openapi/openvidu-meet-api.yaml
index da141fd..dd1120b 100644
--- a/backend/openapi/openvidu-meet-api.yaml
+++ b/backend/openapi/openvidu-meet-api.yaml
@@ -19,7 +19,7 @@ paths:
         $ref: './paths/recordings.yaml#/~1recordings~1{recordingId}'
     /recordings/{recordingId}/media:
         $ref: './paths/recordings.yaml#/~1recordings~1{recordingId}~1media'
-    /recordings/{recordingId/url:
+    /recordings/{recordingId}/url:
         $ref: './paths/recordings.yaml#/~1recordings~1{recordingId}~1url'
 components:
     securitySchemes:
diff --git a/backend/openapi/paths/recordings.yaml b/backend/openapi/paths/recordings.yaml
index 5c146cb..7e6202c 100644
--- a/backend/openapi/paths/recordings.yaml
+++ b/backend/openapi/paths/recordings.yaml
@@ -156,6 +156,7 @@
             - recordingTokenCookie: []
         parameters:
             - $ref: '../components/parameters/recording-id.yaml'
+            - $ref: '../components/parameters/recording-secret.yaml'
             - $ref: '../components/parameters/recording-range.yaml'
         responses:
             '200':
@@ -189,7 +190,7 @@
                             type: string
                             format: binary
             '400':
-                $ref: '../components/responses/invalid-recording-secret.yaml'
+                $ref: '../components/responses/error-invalid-recording-secret.yaml'
             '401':
                 $ref: '../components/responses/unauthorized-error.yaml'
             '403':