backend: Enhance recording IDs description for clarity and formatting

2025-04-23 11:02:02 +02:00 · 2025-04-23 11:02:02 +02:00 · 35edc4d0c0
commit 35edc4d0c0
parent f8a176b4fa
1 changed files with 7 additions and 1 deletions
--- 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.
+    <br>
+    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'