-
Notifications
You must be signed in to change notification settings - Fork 20
/
Copy pathopenapi.yaml
301 lines (287 loc) · 8.44 KB
/
openapi.yaml
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
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
openapi: 3.0.0
info:
description: This is the public API for the Companion Satellite client.
version: 0.1.0
title: Bitfocus Companion Satellite Configuration API
paths:
/status:
get:
summary: Get Connection status to Companion
operationId: getConnectionStatus
responses:
'200':
description: successful operation
content:
application/json:
schema:
$ref: '#/components/schemas/StatusResponse'
'400':
description: failed operation
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
/surfaces:
get:
summary: Get Connected surfaces
operationId: getConnectedSurfaces
responses:
'200':
description: successful operation
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/SurfaceInfo'
'400':
description: failed operation
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
/surfaces/rescan:
post:
summary: Rescan for connected surfaces
operationId: postSurfaceesScan
responses:
'200':
description: successful operation
'400':
description: failed operation
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
/surfaces/plugins/installed:
get:
summary: Get installed surface plugins
operationId: getSurfacePluginsInstalled
responses:
'200':
description: successful operation
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/SurfacePluginInfo'
'400':
description: failed operation
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
/surfaces/plugins/enabled:
get:
summary: Get enabled status of surface plugins
operationId: getSurfacePluginsEnabled
responses:
'200':
description: successful operation
content:
application/json:
schema:
type: object
additionalProperties:
type: boolean
'400':
description: failed operation
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
post:
summary: Update enabled status of surface plugins
operationId: updateSurfacePluginsEnabled
requestBody:
content:
application/json:
schema:
type: object
additionalProperties:
type: boolean
responses:
'200':
description: successful operation
content:
application/json:
schema:
type: object
additionalProperties:
type: boolean
'400':
description: failed operation
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
/config:
get:
summary: Get current configuration
operationId: getConfig
responses:
'200':
description: successful operation
content:
application/json:
schema:
$ref: '#/components/schemas/ConfigData'
'400':
description: failed operation
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
post:
summary: Update current configuration
operationId: updateConfig
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/ConfigDataUpdate'
responses:
'200':
description: successful operation
content:
application/json:
schema:
$ref: '#/components/schemas/ConfigData'
'400':
description: failed operation
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
components:
schemas:
ErrorResponse:
type: object
properties:
error:
type: string
required:
- error
StatusResponse:
type: object
properties:
connected:
type: boolean
description: Whether the client is connected to the Companion Satellite
companionVersion:
type: string
nullable: true
description: Version of the Companion Satellite
companionApiVersion:
type: string
nullable: true
description: API version of the Companion Satellite
companionUnsupportedApi:
type: boolean
description: Whether the last successful Companion connection was with an unsupported API version
required:
- connected
- companionVersion
- companionApiVersion
- companionUnsupportedApi
ConfigData:
type: object
properties:
protocol:
type: string
enum: ['tcp', 'ws']
description: Protocol to use for the connection
host:
type: string
description: Address of the Companion server to connect to, for TCP protocol
port:
type: number
description: Port number of the Companion server to connect to, for TCP protocol
wsAddress:
type: string
description: Address of the Companion server to connect to, for WS protocol
installationName:
type: string
description: Name of the installation, reported in the mDNS announcement
mdnsEnabled:
type: boolean
description: Enable mDNS announcement to allow automatic discovery of the Companion Satellite
httpEnabled:
type: boolean
description: Enable the HTTP api. This is readonly in the HTTP api
httpPort:
type: number
description: Port number of the HTTP api. This is readonly in the HTTP api
required:
- protocol
- host
- port
- wsAddress
- installationName
- mdnsEnabled
- httpEnabled
- httpPort
ConfigDataUpdate:
type: object
properties:
protocol:
type: string
enum: ['tcp', 'ws']
description: Protocol to use for the connection
host:
type: string
description: Address of the Companion server to connect to, for TCP protocol
port:
type: number
description: Port number of the Companion server to connect to, for TCP protocol
wsAddress:
type: string
description: Address of the Companion server to connect to, for WS protocol
installationName:
type: string
description: Name of the installation, reported in the mDNS announcement
mdnsEnabled:
type: boolean
description: Enable mDNS announcement to allow automatic discovery of the Companion Satellite
SurfaceInfo:
type: object
properties:
surfaceId:
type: string
description: ID of the surface
productName:
type: string
description: Product Name of the surface
pluginId:
type: string
description: Plugin ID of the surface
pluginName:
type: string
description: Plugin name of the surface
# isOpen:
# type: boolean
# description: Whether the surface is currently open
required:
- surfaceId
- productName
- pluginId
- pluginName
# - isOpen
SurfacePluginInfo:
type: object
properties:
pluginId:
type: string
description: Plugin ID of the surface
pluginName:
type: string
description: Plugin name of the surface
pluginComment:
type: array
items:
type: string
description: Comment about the plugin
required:
- pluginId
- pluginName