openapi: add room reference to success and error responses for room deletion endpoints

This commit is contained in:
juancarmore 2025-09-05 01:06:21 +02:00
parent fbba17319e
commit 1dd8cc3238
3 changed files with 36 additions and 0 deletions

View File

@ -28,6 +28,8 @@ content:
message:
type: string
description: A message providing additional context about the success
room:
$ref: '../schemas/meet-room.yaml'
description: List of rooms that were successfully processed for deletion
failed:
type: array

View File

@ -27,6 +27,8 @@ content:
message:
type: string
description: A message providing additional context about the success
room:
$ref: '../schemas/meet-room.yaml'
description: List of rooms that were successfully processed for deletion
example:
message: 'All rooms successfully processed for deletion'

View File

@ -17,6 +17,8 @@ content:
message:
type: string
description: A message providing additional context about the success
room:
$ref: '../schemas/meet-room.yaml'
examples:
room_deleted:
value:
@ -34,6 +36,21 @@ content:
value:
successCode: room_closed
message: Room 'room-123' has been closed instead of deleted because it has recordings
room:
roomId: room-123
roomName: room
creationDate: 1620000000000
preferences:
chatPreferences:
enabled: true
recordingPreferences:
enabled: false
virtualBackgroundPreferences:
enabled: true
moderatorUrl: 'http://localhost:6080/room/room-123?secret=123456'
speakerUrl: 'http://localhost:6080/room/room-123?secret=654321'
status: closed
meetingEndAction: none
room_with_active_meeting_and_recordings_deleted:
value:
successCode: room_with_active_meeting_and_recordings_deleted
@ -42,3 +59,18 @@ content:
value:
successCode: room_with_active_meeting_closed
message: Room 'room-123' with active meeting has been closed instead of deleted because it has recordings
room:
roomId: room-123
roomName: room
creationDate: 1620000000000
preferences:
chatPreferences:
enabled: true
recordingPreferences:
enabled: false
virtualBackgroundPreferences:
enabled: true
moderatorUrl: 'http://localhost:6080/room/room-123?secret=123456'
speakerUrl: 'http://localhost:6080/room/room-123?secret=654321'
status: active_meeting
meetingEndAction: close