From eb0664336402b4a4e50ab915b66b11792d29e341 Mon Sep 17 00:00:00 2001
From: Carlos Santos <4a.santos@gmail.com>
Date: Tue, 8 Apr 2025 18:35:18 +0200
Subject: [PATCH] backend: Rename expirationDate to autoDeletionDate in OpenAPI
 specs and update descriptions

---
 .../components/responses/success-get-room.yaml   |  4 ++--
 .../components/responses/success-get-rooms.yaml  |  8 ++++----
 .../components/schemas/meet-room-options.yaml    | 16 ++++++++++------
 .../openapi/components/schemas/meet-room.yaml    | 14 ++++++++++----
 4 files changed, 26 insertions(+), 16 deletions(-)

diff --git a/backend/openapi/components/responses/success-get-room.yaml b/backend/openapi/components/responses/success-get-room.yaml
index 6e28a8c..921bda4 100644
--- a/backend/openapi/components/responses/success-get-room.yaml
+++ b/backend/openapi/components/responses/success-get-room.yaml
@@ -10,7 +10,7 @@ content:
                     roomId: 'room-123'
                     roomIdPrefix: 'room'
                     creationDate: 1620000000000
-                    expirationDate: 1620000800000
+                    autoDeletionDate: 1620000800000
                     preferences:
                         chatPreferences:
                             enabled: true
@@ -32,7 +32,7 @@ content:
                     roomId: 'room-123'
                     roomIdPrefix: 'room'
                     creationDate: 1620000000000
-                    expirationDate: 1620000800000
+                    autoDeletionDate: 1620000800000
                     preferences:
                         chatPreferences:
                             enabled: true
diff --git a/backend/openapi/components/responses/success-get-rooms.yaml b/backend/openapi/components/responses/success-get-rooms.yaml
index 1714e2e..d051aff 100644
--- a/backend/openapi/components/responses/success-get-rooms.yaml
+++ b/backend/openapi/components/responses/success-get-rooms.yaml
@@ -26,7 +26,7 @@ content:
                         - roomId: 'room-123'
                           roomIdPrefix: 'room'
                           creationDate: 1620000000000
-                          expirationDate: 1620000800000
+                          autoDeletionDate: 1620000800000
                           preferences:
                               chatPreferences:
                                   enabled: true
@@ -39,7 +39,7 @@ content:
                         - roomId: 'room-456'
                           roomIdPrefix: 'room'
                           creationDate: 1620001000000
-                          expirationDate: 1620001800000
+                          autoDeletionDate: 1620001800000
                           preferences:
                               chatPreferences:
                                   enabled: false
@@ -67,7 +67,7 @@ content:
                         - roomId: 'room-123'
                           roomIdPrefix: 'room'
                           creationDate: 1620000000000
-                          expirationDate: 1620000800000
+                          autoDeletionDate: 1620000800000
                           preferences:
                               chatPreferences:
                                   enabled: true
@@ -78,7 +78,7 @@ content:
                         - roomId: 'room-456'
                           roomIdPrefix: 'room'
                           creationDate: 1620001000000
-                          expirationDate: 1620001800000
+                          autoDeletionDate: 1620001800000
                           preferences:
                               chatPreferences:
                                   enabled: false
diff --git a/backend/openapi/components/schemas/meet-room-options.yaml b/backend/openapi/components/schemas/meet-room-options.yaml
index 2d1cca6..52ff218 100644
--- a/backend/openapi/components/schemas/meet-room-options.yaml
+++ b/backend/openapi/components/schemas/meet-room-options.yaml
@@ -1,13 +1,17 @@
 type: object
-required:
-    - expirationDate
 properties:
-    expirationDate:
-        type: number
+    autoDeletionDate:
+        type: [number, 'null']
         example: 1620000000000
         description: >
-            The expiration date of the room in milliseconds since the Unix epoch.
-            After this date, the room will be closed and no new participants will be allowed to join.
+            The date and time when the room will be deleted, represented in milliseconds since the Unix epoch.
+
+            After this date, the room will be automatically deleted and no new participants can join.
+
+            If this value is set, the room is marked for deletion but will only be removed after the last
+              participant leaves ("graceful deletion").
+
+            If this value is not defined, the room will exist indefinitely until manually deleted.
     roomIdPrefix:
         type: string
         example: 'room'
diff --git a/backend/openapi/components/schemas/meet-room.yaml b/backend/openapi/components/schemas/meet-room.yaml
index a546483..30a7944 100644
--- a/backend/openapi/components/schemas/meet-room.yaml
+++ b/backend/openapi/components/schemas/meet-room.yaml
@@ -15,12 +15,18 @@ properties:
         example: 1620000000000
         description: >
             The creation date of the room in milliseconds since the Unix epoch.
-    expirationDate:
-        type: number
+    autoDeletionDate:
+        type: [number, 'null']
         example: 1620000800000
         description: >
-            The expiration date of the room in milliseconds since the Unix epoch.
-            After this date, the room will be closed and no new participants will be allowed to join.
+            The date and time when the room will be deleted, represented in milliseconds since the Unix epoch.
+
+            After this date, the room will be automatically deleted and no new participants can join.
+
+            If this value is set, the room is marked for deletion but will only be removed after the last
+              participant leaves ("graceful deletion").
+
+            If this value is not defined, the room will exist indefinitely until manually deleted.
     preferences:
         $ref: meet-room-preferences.yaml#/MeetRoomPreferences
         description: >