openvidu/backend/openapi/components/responses/success-bulk-delete-recordings.yaml

50 lines
2.2 KiB
YAML

description: >
**Mixed results**. Some recordings were deleted successfully while others
could not be deleted (e.g., due to being in progress or not found).
content:
application/json:
schema:
type: object
properties:
deleted:
type: array
items:
type: string
description: List of recordings that were deleted successfully.
notDeleted:
type: array
description: List of recordings that could not be deleted along with the corresponding error messages.
items:
type: object
properties:
recordingId:
type: string
description: The unique identifier of the recording that was not deleted.
example: 'room-123--EG_XYZ--XX447'
error:
type: string
description: A message explaining why the deletion failed.
example: 'Recording not found'
examples:
partial_deletion_with_errors:
summary: Some recordings were deleted successfully, others failed
value:
deleted:
- 'room-123--EG_XYZ--XX445'
- 'room-123--EG_ZYX--XX446'
notDeleted:
- recordingId: 'room-123--EG_XYZ--XX447'
error: 'Recording not found'
- recordingId: 'room-123--EG_XYZ--XX448'
error: 'Recording in progress'
no_deletion_performed:
summary: No recordings were deleted
value:
deleted: []
notDeleted:
- recordingId: 'room-123--EG_XYZ--XX447'
error: 'Recording not found'
- recordingId: 'room-123--EG_ZYX--XX448'
error: 'Recording in progress'