From 14d5637151f586c554f2fe80226087bb5ea450fa Mon Sep 17 00:00:00 2001
From: Carlos Santos <4a.santos@gmail.com>
Date: Wed, 9 Apr 2025 12:02:02 +0200
Subject: [PATCH] backend: Add response schema for bulk room deletion and
 update endpoint responses

---
 .../responses/success-bulk-delete-rooms.yaml  | 46 +++++++++++++++++++
 backend/openapi/paths/rooms.yaml              |  6 ++-
 2 files changed, 50 insertions(+), 2 deletions(-)
 create mode 100644 backend/openapi/components/responses/success-bulk-delete-rooms.yaml

diff --git a/backend/openapi/components/responses/success-bulk-delete-rooms.yaml b/backend/openapi/components/responses/success-bulk-delete-rooms.yaml
new file mode 100644
index 0000000..3b3f74c
--- /dev/null
+++ b/backend/openapi/components/responses/success-bulk-delete-rooms.yaml
@@ -0,0 +1,46 @@
+description: Bulk deletion completed. Includes lists of successfully deleted IDs and marked for deletion IDs.
+content:
+    application/json:
+        schema:
+            type: object
+            properties:
+                deleted:
+                    type: array
+                    items:
+                        type: string
+                    description: List of successfully deleted rooms IDs.
+                    example:
+                        - 'room-123'
+                        - 'room-456'
+                markedAsDeleted:
+                    type: array
+                    description: List of rooms that were marked for deletion but not actually deleted. The rooms will be deleted when all participants leave the room.
+                    items:
+                        type: string
+                        example:
+                            - 'room-789'
+                            - 'room-101'
+        examples:
+            successful_deletion:
+                summary: All rooms were successfully deleted
+                value:
+                    deleted:
+                        - 'room-123'
+                        - 'room-456'
+                    markedAsDeleted: []
+            partial_deletion:
+                summary: Some rooms were deleted successfully, others were marked for deletion
+                value:
+                    deleted:
+                        - 'room-123'
+                        - 'room-456'
+                    markedAsDeleted:
+                        - 'room-789'
+                        - 'room-101'
+            no_deletion_performed:
+                summary: No rooms were deleted
+                value:
+                    deleted: []
+                    markedAsDeleted:
+                        - 'room-789'
+                        - 'room-101'
diff --git a/backend/openapi/paths/rooms.yaml b/backend/openapi/paths/rooms.yaml
index 18e4a6e..e54a0f5 100644
--- a/backend/openapi/paths/rooms.yaml
+++ b/backend/openapi/paths/rooms.yaml
@@ -67,8 +67,8 @@
                   type: string
                   example: 'room-123,room-456'
         responses:
-            '204':
-                description: Bulk deletion completed.
+            '200':
+                $ref: '../components/responses/success-bulk-delete-rooms.yaml'
             '401':
                 $ref: '../components/responses/unauthorized-error.yaml'
             '403':
@@ -127,6 +127,8 @@
         parameters:
             - $ref: '../components/parameters/room-id.yaml'
         responses:
+            '202':
+                description: Room deletion accepted. The room will be deleted when all participants leave.
             '204':
                 description: Successfully deleted the OpenVidu Meet room
             '401':