backend: Add response schema for bulk room deletion and update endpoint responses
This commit is contained in:
parent
6774e56a27
commit
14d5637151
@ -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'
|
||||||
@ -67,8 +67,8 @@
|
|||||||
type: string
|
type: string
|
||||||
example: 'room-123,room-456'
|
example: 'room-123,room-456'
|
||||||
responses:
|
responses:
|
||||||
'204':
|
'200':
|
||||||
description: Bulk deletion completed.
|
$ref: '../components/responses/success-bulk-delete-rooms.yaml'
|
||||||
'401':
|
'401':
|
||||||
$ref: '../components/responses/unauthorized-error.yaml'
|
$ref: '../components/responses/unauthorized-error.yaml'
|
||||||
'403':
|
'403':
|
||||||
@ -127,6 +127,8 @@
|
|||||||
parameters:
|
parameters:
|
||||||
- $ref: '../components/parameters/room-id.yaml'
|
- $ref: '../components/parameters/room-id.yaml'
|
||||||
responses:
|
responses:
|
||||||
|
'202':
|
||||||
|
description: Room deletion accepted. The room will be deleted when all participants leave.
|
||||||
'204':
|
'204':
|
||||||
description: Successfully deleted the OpenVidu Meet room
|
description: Successfully deleted the OpenVidu Meet room
|
||||||
'401':
|
'401':
|
||||||
|
|||||||
Loading…
x
Reference in New Issue
Block a user