-
Notifications
You must be signed in to change notification settings - Fork 0
/
openapi-spec.yml
112 lines (112 loc) 路 2.7 KB
/
openapi-spec.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
openapi: 3.0.0
info:
title: On Air sign API
version: 1.0.0
servers:
- url: http://on-air
tags:
- name: Mode
- name: Zoom Alert
- name: Status
- name: Message
paths:
/api/mode:
delete:
tags:
- Mode
summary: Set a blank screen
responses:
'204':
description: Successful response
put:
tags:
- Mode
summary: Choose a display mode
description: To be displayed unless alert is active
requestBody:
content:
application/json:
schema:
type: object
examples:
Clock:
value:
name: clock
Random Pixels:
value:
name: random-pixels
Marquee:
value:
name: marquee
responses:
'204':
description: Successful response
/api/message:
put:
tags:
- Message
summary: Supply a marquee message
description: To be displayed when the "scrolling text" mode is active. Maximum length of 255 characters, normalised to ASCII.
requestBody:
content:
application/json:
schema:
type: object
example:
value: A sample message!
responses:
'204':
description: Successful response
'400':
description: Invalid message
'413':
description: Message contents longer than 255 characters
/api/alert/zoom/call:
put:
tags:
- Zoom Alert
summary: Zoom meeting has started
responses:
'204':
description: Successful response
delete:
tags:
- Zoom Alert
summary: Zoom meeting has ended
responses:
'204':
description: Successful response
/api/alert/zoom:
put:
tags:
- Zoom Alert
summary: Enable automatic "On Air" alert when Zoom call starts
responses:
'204':
description: Successful response
delete:
tags:
- Zoom Alert
summary: Disable automatic "On Air" alert when Zoom call starts
responses:
'204':
description: Successful response
/api/status:
get:
tags:
- Status
summary: Get system status metrics
responses:
'200':
description: Successful response
content:
application/json:
schema:
type: object
example:
mode: clock
message: Hello world!
temperature: 24.25
zoom:
alert-active: true
call-in-progress: false