diff options
Diffstat (limited to 'rest-api/api-docs/bridges.json')
| -rw-r--r-- | rest-api/api-docs/bridges.json | 52 |
1 files changed, 47 insertions, 5 deletions
diff --git a/rest-api/api-docs/bridges.json b/rest-api/api-docs/bridges.json index 5b0cf6298..87d5b3d4f 100644 --- a/rest-api/api-docs/bridges.json +++ b/rest-api/api-docs/bridges.json @@ -31,8 +31,8 @@ "required": false, "allowMultiple": false, "dataType": "string", - "allowedValues": { - "type": "LIST", + "allowableValues": { + "valueType": "LIST", "values": [ "mixing", "holding" @@ -61,6 +61,12 @@ "allowMultiple": false, "dataType": "string" } + ], + "errorResponses": [ + { + "code": 404, + "reason": "Bridge not found" + } ] }, { @@ -78,6 +84,12 @@ "allowMultiple": false, "dataType": "string" } + ], + "errorResponses": [ + { + "code": 404, + "reason": "Bridge not found" + } ] } ] @@ -108,6 +120,20 @@ "allowMultiple": true, "dataType": "string" } + ], + "errorResponses": [ + { + "code": 404, + "reason": "Bridge not found" + }, + { + "code": 409, + "reason": "Bridge not in Stasis application" + }, + { + "code": 422, + "reason": "Channel not found, or not in Stasis application" + } ] } ] @@ -231,19 +257,35 @@ "models": { "Bridge": { "id": "Bridge", + "description": "The merging of media from one or more channels.\n\nEveryone on the bridge receives the same audio.", "properties": { - "bridgeType": { + "id": { + "type": "string", + "description": "Unique identifier for this bridge", + "required": true + }, + "technology": { + "type": "string", + "description": "Name of the current bridging technology", + "required": true + }, + "bridge_type": { "type": "string", "description": "Type of bridge technology", "required": true, - "allowedValues": { - "type": "LIST", + "allowableValues": { + "valueType": "LIST", "values": [ "mixing", "holding" ] } }, + "bridge_class": { + "type": "string", + "description": "Bridging class", + "required": true + }, "channels": { "type": "List[string]", "description": "Id's of channels participating in this bridge", |