From 35edc4d0c064ff07031c8651ddf2eb7e29c0d0db Mon Sep 17 00:00:00 2001 From: Carlos Santos <4a.santos@gmail.com> Date: Wed, 23 Apr 2025 11:02:02 +0200 Subject: [PATCH] backend: Enhance recording IDs description for clarity and formatting --- backend/openapi/components/parameters/recording-ids.yaml | 8 +++++++- 1 file changed, 7 insertions(+), 1 deletion(-) 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'