diff options
Diffstat (limited to 'rest-api')
| -rw-r--r-- | rest-api/api-docs/bridges.json | 28 | ||||
| -rw-r--r-- | rest-api/api-docs/channels.json | 2 | ||||
| -rw-r--r-- | rest-api/api-docs/events.json | 41 | ||||
| -rw-r--r-- | rest-api/api-docs/recordings.json | 6 |
4 files changed, 60 insertions, 17 deletions
diff --git a/rest-api/api-docs/bridges.json b/rest-api/api-docs/bridges.json index 819c777db..187522826 100644 --- a/rest-api/api-docs/bridges.json +++ b/rest-api/api-docs/bridges.json @@ -454,20 +454,20 @@ } } ], - "errorResponses": [ - { - "code": 400, - "reason": "Recording name invalid" - }, - { - "code": 404, - "reason": "Bridge not found" - }, - { - "code": 409, - "reason": "Bridge not in Stasis application; Recording already in progress" - } - ] + "errorResponses": [ + { + "code": 400, + "reason": "Invalid parameters" + }, + { + "code": 404, + "reason": "Bridge not found" + }, + { + "code": 409, + "reason": "Bridge is not in a Stasis application; A recording with the same name already exists on the system and can not be overwritten because it is in progress or ifExists=fail" + } + ] } ] } diff --git a/rest-api/api-docs/channels.json b/rest-api/api-docs/channels.json index 55997bb69..a9b55873a 100644 --- a/rest-api/api-docs/channels.json +++ b/rest-api/api-docs/channels.json @@ -720,7 +720,7 @@ }, { "code": 409, - "reason": "Channel is not in a Stasis application; the channel is currently bridged with other channels; A recording with the same name is currently in progress." + "reason": "Channel is not in a Stasis application; the channel is currently bridged with other hcannels; A recording with the same name already exists on the system and can not be overwritten because it is in progress or ifExists=fail" } ] } diff --git a/rest-api/api-docs/events.json b/rest-api/api-docs/events.json index a9ea45c81..8692400a4 100644 --- a/rest-api/api-docs/events.json +++ b/rest-api/api-docs/events.json @@ -120,6 +120,47 @@ } } }, + "RecordingStarted": { + "id": "RecordingStarted", + "extends": "Event", + "description": "Event showing the start of a recording operation.", + "properties": { + "recording": { + "type": "LiveRecording", + "description": "Recording control object", + "required": true + } + } + }, + "RecordingFinished": { + "id": "RecordingFinished", + "extends": "Event", + "description": "Event showing the completion of a recording operation.", + "properties": { + "recording": { + "type": "LiveRecording", + "description": "Recording control object", + "required": true + } + } + }, + "RecordingFailed": { + "id": "RecordingFailed", + "extends": "Event", + "description": "Event showing failure of a recording operation.", + "properties": { + "recording": { + "type": "LiveRecording", + "description": "Recording control object", + "required": true + }, + "cause": { + "type": "string", + "description": "Cause for the recording failure", + "required": true + } + } + }, "ApplicationReplaced": { "id": "ApplicationReplaced", "description": "Notification that another WebSocket has taken over for an application.\n\nAn application may only be subscribed to by a single WebSocket at a time. If multiple WebSockets attempt to subscribe to the same application, the newer WebSocket wins, and the older one receives this event.", diff --git a/rest-api/api-docs/recordings.json b/rest-api/api-docs/recordings.json index 5767ce479..93340c10e 100644 --- a/rest-api/api-docs/recordings.json +++ b/rest-api/api-docs/recordings.json @@ -309,9 +309,11 @@ "valueType": "LIST", "values": [ "queued", - "playing", + "recording", "paused", - "done" + "done", + "failed", + "canceled" ] } }, |