1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
|
{
"_copyright": "Copyright (C) 2013, Digium, Inc.",
"_author": "David M. Lee, II <dlee@digium.com>",
"_svn_revision": "$Revision$",
"apiVersion": "1.6.0",
"swaggerVersion": "1.1",
"basePath": "http://localhost:8088/ari",
"resourcePath": "/api-docs/applications.{format}",
"apis": [
{
"path": "/applications",
"description": "Stasis applications",
"operations": [
{
"httpMethod": "GET",
"summary": "List all applications.",
"nickname": "list",
"responseClass": "List[Application]"
}
]
},
{
"path": "/applications/{applicationName}",
"description": "Stasis application",
"operations": [
{
"httpMethod": "GET",
"summary": "Get details of an application.",
"nickname": "get",
"responseClass": "Application",
"parameters": [
{
"name": "applicationName",
"description": "Application's name",
"paramType": "path",
"required": true,
"allowMultiple": false,
"dataType": "string"
}
],
"errorResponses": [
{
"code": 404,
"reason": "Application does not exist."
}
]
}
]
},
{
"path": "/applications/{applicationName}/subscription",
"description": "Stasis application",
"operations": [
{
"httpMethod": "POST",
"summary": "Subscribe an application to a event source.",
"notes": "Returns the state of the application after the subscriptions have changed",
"nickname": "subscribe",
"responseClass": "Application",
"parameters": [
{
"name": "applicationName",
"description": "Application's name",
"paramType": "path",
"required": true,
"allowMultiple": false,
"dataType": "string"
},
{
"name": "eventSource",
"description": "URI for event source (channel:{channelId}, bridge:{bridgeId}, endpoint:{tech}[/{resource}], deviceState:{deviceName}",
"paramType": "query",
"required": true,
"allowMultiple": true,
"dataType": "string"
}
],
"errorResponses": [
{
"code": 400,
"reason": "Missing parameter."
},
{
"code": 404,
"reason": "Application does not exist."
},
{
"code": 422,
"reason": "Event source does not exist."
}
]
},
{
"httpMethod": "DELETE",
"summary": "Unsubscribe an application from an event source.",
"notes": "Returns the state of the application after the subscriptions have changed",
"nickname": "unsubscribe",
"responseClass": "Application",
"parameters": [
{
"name": "applicationName",
"description": "Application's name",
"paramType": "path",
"required": true,
"allowMultiple": false,
"dataType": "string"
},
{
"name": "eventSource",
"description": "URI for event source (channel:{channelId}, bridge:{bridgeId}, endpoint:{tech}[/{resource}], deviceState:{deviceName}",
"paramType": "query",
"required": true,
"allowMultiple": true,
"dataType": "string"
}
],
"errorResponses": [
{
"code": 400,
"reason": "Missing parameter; event source scheme not recognized."
},
{
"code": 404,
"reason": "Application does not exist."
},
{
"code": 409,
"reason": "Application not subscribed to event source."
},
{
"code": 422,
"reason": "Event source does not exist."
}
]
}
]
}
],
"models": {
"Application": {
"id": "Application",
"description": "Details of a Stasis application",
"properties": {
"name": {
"type": "string",
"description": "Name of this application",
"required": true
},
"channel_ids": {
"type": "List[string]",
"description": "Id's for channels subscribed to.",
"required": true
},
"bridge_ids": {
"type": "List[string]",
"description": "Id's for bridges subscribed to.",
"required": true
},
"endpoint_ids": {
"type": "List[string]",
"description": "{tech}/{resource} for endpoints subscribed to.",
"required": true
},
"device_names": {
"type": "List[string]",
"description": "Names of the devices subscribed to.",
"required": true
}
}
}
}
}
|
