diff --git a/backend/openapi/components/responses/success-bulk-delete-rooms.yaml b/backend/openapi/components/responses/success-bulk-delete-rooms.yaml index c0aed9e..66c7c6a 100644 --- a/backend/openapi/components/responses/success-bulk-delete-rooms.yaml +++ b/backend/openapi/components/responses/success-bulk-delete-rooms.yaml @@ -1,4 +1,4 @@ -description: Bulk deletion completed. Includes lists of successfully deleted IDs and marked for deletion IDs. +description: Mixed results for bulk deletion operation content: application/json: schema: @@ -8,39 +8,16 @@ content: type: array items: type: string - description: List of successfully deleted rooms IDs. - example: - - 'room-123' - - 'room-456' - markedAsDeleted: + description: List of rooms that were deleted immediately + markedForDeletion: type: array items: type: string description: List of rooms that were marked for deletion but not actually deleted. The rooms will be deleted when all participants leave the room. - 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' + example: + deleted: + - 'room-123' + - 'room-456' + markedForDeletion: + - 'room-789' + - 'room-101' diff --git a/backend/openapi/components/responses/success-room-marked-for-deletion.yaml b/backend/openapi/components/responses/success-room-marked-for-deletion.yaml index 26d2b8c..6d1418e 100644 --- a/backend/openapi/components/responses/success-room-marked-for-deletion.yaml +++ b/backend/openapi/components/responses/success-room-marked-for-deletion.yaml @@ -1,4 +1,4 @@ -description: Room deletion accepted. The room will be deleted when all participants leave. +description: All specified rooms have been marked for deletion. content: application/json: schema: @@ -6,4 +6,15 @@ content: properties: message: type: string - example: 'Room marked for deletion' + markedForDeletion: + type: array + items: + type: string + example: + - room-123 + - room-456 + example: + message: Rooms room-123, room-456 marked for deletion + markedForDeletion: + - room-123 + - room-456 diff --git a/backend/openapi/paths/rooms.yaml b/backend/openapi/paths/rooms.yaml index 9f0c697..ac57a2a 100644 --- a/backend/openapi/paths/rooms.yaml +++ b/backend/openapi/paths/rooms.yaml @@ -69,11 +69,19 @@ - $ref: '../components/parameters/force-deletion.yaml' responses: '200': + description: > + **Mixed results**. Some rooms were deleted immediately while others were + marked for deletion (due to active participants). $ref: '../components/responses/success-bulk-delete-rooms.yaml' '202': + description: > + All specified rooms were marked for deletion (due to active participants) + and will be removed once all participants leave. $ref: '../components/responses/success-room-marked-for-deletion.yaml' '204': - description: Successfully deleted the OpenVidu Meet room + description: > + All specified rooms were successfully deleted immediately. + No content is returned in the response body. '401': $ref: '../components/responses/unauthorized-error.yaml' '403':