diff --git a/backend/openapi/components/parameters/recording-ids.yaml b/backend/openapi/components/parameters/recording-ids.yaml index 4579362..3f49aaa 100644 --- a/backend/openapi/components/parameters/recording-ids.yaml +++ b/backend/openapi/components/parameters/recording-ids.yaml @@ -1,7 +1,13 @@ name: recordingIds in: query required: true -description: A comma-separated list of recording IDs to delete. +description: > + A comma-separated list of recording IDs to delete. +
+ Each recording ID should be in the format 'roomId--sessionId--recordingId'. + + > ⚠️ **Note:** If the recording is in progress, it cannot be deleted. + schema: type: string example: 'room-123--EG_XYZ--XX445,room-123--EG_ZYX--XX446'