diff options
Diffstat (limited to 'rest-api')
| -rw-r--r-- | rest-api/api-docs/events.json | 54 |
1 files changed, 29 insertions, 25 deletions
diff --git a/rest-api/api-docs/events.json b/rest-api/api-docs/events.json index ac3f6521c..a9ea45c81 100644 --- a/rest-api/api-docs/events.json +++ b/rest-api/api-docs/events.json @@ -3,7 +3,7 @@ "_author": "David M. Lee, II <dlee@digium.com>", "_svn_revision": "$Revision$", "apiVersion": "0.0.1", - "swaggerVersion": "1.3", + "swaggerVersion": "1.2", "basePath": "http://localhost:8088/stasis", "resourcePath": "/api-docs/events.{format}", "apis": [ @@ -43,11 +43,14 @@ "required": true, "description": "Indicates the type of this message." } - } + }, + "subTypes": [ + "MissingParams", + "Event" + ] }, "MissingParams": { "id": "MissingParams", - "extends": "Message", "description": "Error event sent when required params are missing.", "properties": { "params": { @@ -59,7 +62,6 @@ }, "Event": { "id": "Event", - "extends": "Message", "description": "Base type for asynchronous events from Asterisk.", "properties": { "application": { @@ -72,11 +74,32 @@ "description": "Time at which this event was created.", "required": false } - } + }, + "subTypes": [ + "PlaybackStarted", + "PlaybackFinished", + "ApplicationReplaced", + "BridgeCreated", + "BridgeDestroyed", + "BridgeMerged", + "ChannelCreated", + "ChannelDestroyed", + "ChannelEnteredBridge", + "ChannelLeftBridge", + "ChannelStateChange", + "ChannelDtmfReceived", + "ChannelDialplan", + "ChannelCallerId", + "ChannelUserevent", + "ChannelHangupRequest", + "ChannelVarset", + "EndpointStateChange", + "StasisEnd", + "StasisStart" + ] }, "PlaybackStarted": { "id": "PlaybackStarted", - "extends": "Event", "description": "Event showing the start of a media playback operation.", "properties": { "playback": { @@ -88,7 +111,6 @@ }, "PlaybackFinished": { "id": "PlaybackFinished", - "extends": "Event", "description": "Event showing the completion of a media playback operation.", "properties": { "playback": { @@ -100,13 +122,11 @@ }, "ApplicationReplaced": { "id": "ApplicationReplaced", - "extends": "Event", "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.", "properties": {} }, "BridgeCreated": { "id": "BridgeCreated", - "extends": "Event", "description": "Notification that a bridge has been created.", "properties": { "bridge": { @@ -117,7 +137,6 @@ }, "BridgeDestroyed": { "id": "BridgeDestroyed", - "extends": "Event", "description": "Notification that a bridge has been destroyed.", "properties": { "bridge": { @@ -128,7 +147,6 @@ }, "BridgeMerged": { "id": "BridgeMerged", - "extends": "Event", "description": "Notification that one bridge has merged into another.", "properties": { "bridge": { @@ -143,7 +161,6 @@ }, "ChannelCreated": { "id": "ChannelCreated", - "extends": "Event", "description": "Notification that a channel has been created.", "properties": { "channel": { @@ -154,7 +171,6 @@ }, "ChannelDestroyed": { "id": "ChannelDestroyed", - "extends": "Event", "description": "Notification that a channel has been destroyed.", "properties": { "cause": { @@ -175,7 +191,6 @@ }, "ChannelEnteredBridge": { "id": "ChannelEnteredBridge", - "extends": "Event", "description": "Notification that a channel has entered a bridge.", "properties": { "bridge": { @@ -189,7 +204,6 @@ }, "ChannelLeftBridge": { "id": "ChannelLeftBridge", - "extends": "Event", "description": "Notification that a channel has left a bridge.", "properties": { "bridge": { @@ -204,7 +218,6 @@ }, "ChannelStateChange": { "id": "ChannelStateChange", - "extends": "Event", "description": "Notification of a channel's state change.", "properties": { "channel": { @@ -215,7 +228,6 @@ }, "ChannelDtmfReceived": { "id": "ChannelDtmfReceived", - "extends": "Event", "description": "DTMF received on a channel.\n\nThis event is sent when the DTMF ends. There is no notification about the start of DTMF", "properties": { "digit": { @@ -237,7 +249,6 @@ }, "ChannelDialplan": { "id": "ChannelDialplan", - "extends": "Event", "description": "Channel changed location in the dialplan.", "properties": { "channel": { @@ -259,7 +270,6 @@ }, "ChannelCallerId": { "id": "ChannelCallerId", - "extends": "Event", "description": "Channel changed Caller ID.", "properties": { "caller_presentation": { @@ -281,7 +291,6 @@ }, "ChannelUserevent": { "id": "ChannelUserevent", - "extends": "Event", "description": "User-generated event with additional user-defined fields in the object.", "properties": { "eventname": { @@ -303,7 +312,6 @@ }, "ChannelHangupRequest": { "id": "ChannelHangupRequest", - "extends": "Event", "description": "A hangup was requested on the channel.", "properties": { "cause": { @@ -323,7 +331,6 @@ }, "ChannelVarset": { "id": "ChannelVarset", - "extends": "Event", "description": "Channel variable changed.", "properties": { "variable": { @@ -345,7 +352,6 @@ }, "EndpointStateChange": { "id": "EndpointStateChange", - "extends": "Event", "description": "Endpoint state changed.", "properties": { "endpoint": { @@ -356,7 +362,6 @@ }, "StasisEnd": { "id": "StasisEnd", - "extends": "Event", "description": "Notification that a channel has left a Stasis appliction.", "properties": { "channel": { @@ -367,7 +372,6 @@ }, "StasisStart": { "id": "StasisStart", - "extends": "Event", "description": "Notification that a channel has entered a Stasis appliction.", "properties": { "args": { |