forked from m1k1o/neko-rooms
-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathOpenApi.yml
571 lines (557 loc) · 13.1 KB
/
OpenApi.yml
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
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
openapi: 3.0.0
info:
title: Neko Rooms
version: 1.0.0
servers:
# Added by API Auto Mocking Plugin
- description: SwaggerHub API Auto Mocking
url: https://virtserver.swaggerhub.com/m1k1o/neko-rooms/1.0.0
tags:
- name: config
description: config endpoints
- name: rooms
description: room endpoints
paths:
/api/config/rooms:
get:
tags:
- config
summary: Get rooms config
operationId: roomsConfig
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/RoomsConfig'
'500':
description: Internal server error
/api/rooms:
get:
tags:
- rooms
summary: List all rooms
operationId: roomsList
responses:
'200':
description: OK
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/RoomEntry'
'500':
description: Internal server error
post:
tags:
- rooms
summary: Create new room
operationId: roomCreate
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/RoomSettings'
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/RoomEntry'
'400':
description: Bad request
'500':
description: Internal server error
/api/rooms/{roomId}:
get:
tags:
- rooms
summary: Get room entry
operationId: roomGet
parameters:
- in: path
name: roomId
required: true
schema:
type: string
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/RoomEntry'
'400':
description: Bad request
'500':
description: Internal server error
delete:
tags:
- rooms
summary: Remove room
operationId: roomRemove
parameters:
- in: path
name: roomId
required: true
schema:
type: string
responses:
'204':
description: OK
'500':
description: Internal server error
/api/rooms/{roomId}/settings:
get:
tags:
- rooms
summary: Get room settings
operationId: roomSettings
parameters:
- in: path
name: roomId
required: true
schema:
type: string
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/RoomSettings'
'400':
description: Bad request
'500':
description: Internal server error
/api/rooms/{roomId}/stats:
get:
tags:
- rooms
summary: Get room statistics
operationId: roomStats
parameters:
- in: path
name: roomId
required: true
schema:
type: string
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/RoomStats'
'500':
description: Internal server error
/api/rooms/{roomId}/stop:
post:
tags:
- rooms
summary: Stop room
operationId: roomStop
parameters:
- in: path
name: roomId
required: true
schema:
type: string
responses:
'204':
description: OK
'500':
description: Internal server error
/api/rooms/{roomId}/start:
post:
tags:
- rooms
summary: Start room
operationId: roomStart
parameters:
- in: path
name: roomId
required: true
schema:
type: string
responses:
'204':
description: OK
'500':
description: Internal server error
/api/rooms/{roomId}/restart:
post:
tags:
- rooms
summary: Restart room
operationId: roomRestart
parameters:
- in: path
name: roomId
required: true
schema:
type: string
responses:
'204':
description: OK
'500':
description: Internal server error
/api/rooms/{roomId}/recreate:
post:
tags:
- rooms
summary: Recreate room
operationId: roomRecreate
parameters:
- in: path
name: roomId
required: true
schema:
type: string
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/RoomEntry'
'500':
description: Internal server error
/api/pull:
get:
tags:
- default
summary: Get pull status
operationId: pullStatus
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/PullStatus'
'500':
description: Internal server error
post:
tags:
- default
summary: Start new pull
operationId: pullStart
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/PullStart'
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/PullStatus'
'500':
description: Internal server error
delete:
tags:
- default
summary: Stop existing pull in progress
operationId: pullStop
responses:
'204':
description: OK
'500':
description: Internal server error
components:
schemas:
RoomsConfig:
type: object
properties:
connections:
type: number
example: 100
neko_images:
type: array
items:
type: string
example: m1k1o/neko:latest
storage_enabled:
type: boolean
example: true
uses_mux:
type: boolean
example: true
RoomEntry:
type: object
properties:
id:
type: string
example: bc04dace10
url:
type: string
example: http://neko-rooms.server.lan/foobar/
name:
type: string
example: foobar
neko_image:
type: string
example: m1k1o/neko:latest
is_outdated:
type: boolean
example: true
max_connections:
type: number
example: 10
description: 0 when using mux
running:
type: boolean
example: true
status:
type: string
example: Up 2 seconds
created:
type: string
format: datetime
example: "2021-03-07T21:56:34Z"
RoomMount:
type: object
properties:
type:
type: string
enum: [ private, template, protected, public ]
example: private
host_path:
type: string
example: /profile
container_path:
type: string
example: /home/neko/.config/chromium
RoomResources:
type: object
properties:
cpu_shares:
type: number
description: relative weight vs. other containers
nano_cpus:
type: number
description: in units of 10^-9 CPUs
shm_size:
type: number
description: in bytes
default: 2000000000
memory:
type: number
description: in bytes
gpus:
type: array
items:
type: string
example: all
RoomSettings:
type: object
properties:
name:
type: string
example: foobar
neko_image:
type: string
example: m1k1o/neko:latest
max_connections:
type: number
default: 10
description: 0 when using mux
user_pass:
type: string
example: neko
admin_pass:
type: string
example: admin
control_protection:
type: boolean
example: true
implicit_control:
type: boolean
example: true
broadcast_pipeline:
type: string
screen:
type: string
example: 1920x1080@60
video_codec:
type: string
example: VP8
video_bitrate:
type: number
example: 3072
video_pipeline:
type: string
video_max_fps:
type: number
example: 25
audio_codec:
type: string
example: OPUS
audio_bitrate:
type: number
example: 128
audio_pipeline:
type: string
envs:
type: object
additionalProperties:
type: string
example:
CUSTOM_ENV: custom value
mounts:
type: array
items:
$ref: '#/components/schemas/RoomMount'
resources:
$ref: '#/components/schemas/RoomResources'
browser_policy:
$ref: '#/components/schemas/BrowserPolicy'
RoomStats:
type: object
properties:
connections:
type: number
example: 3
host:
type: string
example: foobar
members:
type: array
items:
$ref: '#/components/schemas/RoomMember'
banned:
type: object
additionalProperties:
type: string
example:
192.168.1.8: session_id
locked:
type: object
additionalProperties:
type: string
example:
control: session_id
login: session_id
server_started_at:
type: string
format: datetime
example: "2021-03-07T21:56:34Z"
last_admin_left_at:
type: string
nullable: true
format: datetime
example: null
last_user_left_at:
type: string
nullable: true
format: datetime
example: "2021-03-07T21:56:34Z"
control_protection:
type: boolean
example: true
implicit_control:
type: boolean
example: true
RoomMember:
type: object
properties:
id:
type: string
example: foobar
displayname:
type: string
example: Foo Bar
admin:
type: boolean
example: true
muted:
type: boolean
example: false
BrowserPolicy:
type: object
properties:
type:
type: string
enum: [ firefox, chromium ]
path:
type: string
example: /usr/lib/firefox/distribution/policies.json
content:
$ref: '#/components/schemas/BrowserPolicyContent'
BrowserPolicyContent:
type: object
properties:
extensions:
type: array
items:
$ref: '#/components/schemas/BrowserPolicyExtension'
developer_tools:
type: boolean
example: true
persistent_data:
type: boolean
example: false
BrowserPolicyExtension:
type: object
properties:
id:
type: string
example: [email protected]
url:
type: string
example: https://addons.mozilla.org/firefox/downloads/latest/ublock-origin/latest.xpi
PullStart:
type: object
properties:
neko_image:
type: string
example: m1k1o/neko:latest
registry_user:
type: string
registry_pass:
type: string
PullLayer:
type: object
properties:
status:
type: string
example: m1k1o/neko:latest
progressDetail:
type: object
properties:
current:
type: number
total:
type: number
progress:
type: string
id:
type: string
PullStatus:
type: object
properties:
active:
type: boolean
example: true
started:
type: string
format: datetime
example: "2021-03-07T21:56:34Z"
layers:
type: array
items:
$ref: '#/components/schemas/PullLayer'
status:
type: array
items:
type: string
finished:
type: string
format: datetime
example: "2021-03-07T21:56:34Z"