diff options
| author | David M. Lee <dlee@digium.com> | 2013-07-05 19:15:27 +0000 |
|---|---|---|
| committer | David M. Lee <dlee@digium.com> | 2013-07-05 19:15:27 +0000 |
| commit | 01c21c7aeae598c2a164d0dd76ebfe00e8d3622e (patch) | |
| tree | 28b8968b965f7f8860242c01a6248608dfb5394a /rest-api | |
| parent | d0a55fa52dcc29f2db3e22549c9c2f2e68cada56 (diff) | |
Document MissingParams error message for /ari/events
git-svn-id: https://origsvn.digium.com/svn/asterisk/trunk@393749 65c4cc65-6c06-0410-ace0-fbb531ad65f3
Diffstat (limited to 'rest-api')
| -rw-r--r-- | rest-api/api-docs/events.json | 31 |
1 files changed, 25 insertions, 6 deletions
diff --git a/rest-api/api-docs/events.json b/rest-api/api-docs/events.json index 79908eff7..519bb7ae7 100644 --- a/rest-api/api-docs/events.json +++ b/rest-api/api-docs/events.json @@ -17,7 +17,7 @@ "websocketProtocol": "ari", "summary": "WebSocket connection for events.", "nickname": "eventWebsocket", - "responseClass": "Event", + "responseClass": "Message", "parameters": [ { "name": "app", @@ -33,16 +33,35 @@ } ], "models": { - "Event": { - "id": "Event", - "description": "Base type for asynchronous events from Asterisk.", + "Message": { + "id": "Message", + "description": "Base type for errors and events", "discriminator": "type", "properties": { "type": { "type": "string", "required": true, - "description": "Indicates the type of this event." - }, + "description": "Indicates the type of this message." + } + } + }, + "MissingParams": { + "id": "MissingParams", + "extends": "Message", + "description": "Error event sent when required params are missing.", + "properties": { + "params": { + "required": true, + "type": "List[string]", + "description": "A list of the missing parameters" + } + } + }, + "Event": { + "id": "Event", + "extends": "Message", + "description": "Base type for asynchronous events from Asterisk.", + "properties": { "application": { "type": "string", "description": "Name of the application receiving the event.", |