From dbf0743850cb8b8370a6882c873e764f7a317b66 Mon Sep 17 00:00:00 2001
From: Carlos Santos <4a.santos@gmail.com>
Date: Wed, 2 Apr 2025 16:07:29 +0200
Subject: [PATCH] backend: Upgrade OpenAPI version to 3.1.0 and enhance API
 documentation for clarity and consistency

---
 backend/openapi/openvidu-meet-api.yaml        | 26 ++++++++++++-------
 .../openapi/openvidu-meet-internal-api.yaml   | 23 +++++++++-------
 2 files changed, 29 insertions(+), 20 deletions(-)

diff --git a/backend/openapi/openvidu-meet-api.yaml b/backend/openapi/openvidu-meet-api.yaml
index b649522..dd8e1e1 100644
--- a/backend/openapi/openvidu-meet-api.yaml
+++ b/backend/openapi/openvidu-meet-api.yaml
@@ -1,19 +1,23 @@
-openapi: 3.0.1
+openapi: 3.1.0
 info:
-    version: v1
     title: OpenVidu Meet REST API
     description: >
-        The OpenVidu Meet REST API allows seamless integration of OpenVidu Meet rooms into your application.
-        This REST API provides endpoints to manage rooms and recordings in OpenVidu Meet.
-    termsOfService: https://openvidu.io/conditions/terms-of-service/
+        The OpenVidu Meet REST API provides a comprehensive set of endpoints for integrating real-time video
+        conferencing capabilities into your applications.
     contact:
         name: OpenVidu
         email: commercial@openvidu.io
         url: https://openvidu.io/support/
+    license:
+        name: Apache License 2.0
+        identifier: Apache-2.0
+        url: https://www.apache.org/licenses/LICENSE-2.0
+    version: v1
+    termsOfService: https://openvidu.io/conditions/terms-of-service/
 
 servers:
-    - url: http://localhost:6080/meet/api/v1
-      description: Development server
+    - url: /meet/api/v1
+      description: OpenVidu Meet API
 
 tags:
     - name: OpenVidu Meet - Room
@@ -151,7 +155,7 @@ paths:
                                     rooms:
                                         type: array
                                         items:
-                                          $ref: '#/components/schemas/MeetRoom'
+                                            $ref: '#/components/schemas/MeetRoom'
                                     pagination:
                                         type: object
                                         properties:
@@ -1114,9 +1118,8 @@ components:
                           example: 100
                           description: The error code of the recording.
                       error:
-                          type: string
+                          type: [string, 'null']
                           description: The error message of the recording.
-                          nullable: true
                       details:
                           type: string
                           example: 'Stopped using API'
@@ -1134,3 +1137,6 @@ components:
                     type: string
                 message:
                     type: string
+                code:
+                    type: integer
+                    description: HTTP status code associated with the error
diff --git a/backend/openapi/openvidu-meet-internal-api.yaml b/backend/openapi/openvidu-meet-internal-api.yaml
index f05e93e..1bbf345 100644
--- a/backend/openapi/openvidu-meet-internal-api.yaml
+++ b/backend/openapi/openvidu-meet-internal-api.yaml
@@ -1,19 +1,23 @@
-openapi: 3.0.1
+openapi: 3.1.0
 info:
-    version: v1
-    title: OpenVidu Meet Internal REST API
+    title: OpenVidu Meet REST API
     description: >
-        The OpenVidu Meet Internal REST API allows seamless integration of OpenVidu Meet rooms into your application.
-        This REST API provides endpoints to manage rooms and recordings in OpenVidu Meet.
-    termsOfService: https://openvidu.io/conditions/terms-of-service/
+        The OpenVidu Meet REST API provides a comprehensive set of endpoints for integrating real-time video
+        conferencing capabilities into your applications.
     contact:
         name: OpenVidu
         email: commercial@openvidu.io
         url: https://openvidu.io/support/
+    license:
+        name: Apache License 2.0
+        identifier: Apache-2.0
+        url: https://www.apache.org/licenses/LICENSE-2.0
+    version: v1
+    termsOfService: https://openvidu.io/conditions/terms-of-service/
 
 servers:
-    - url: http://localhost:6080/meet/internal-api/v1
-      description: Development server
+    - url: /meet/internal-api/v1
+      description: OpenVidu Meet Internal API
 tags:
     - name: Internal API - Authentication
       description: Authentication operations
@@ -712,9 +716,8 @@ components:
                           example: 100
                           description: The error code of the recording.
                       error:
-                          type: string
+                          type: [string, 'null']
                           description: The error message of the recording.
-                          nullable: true
                       details:
                           type: string
                           example: 'Stopped using API'