-
Notifications
You must be signed in to change notification settings - Fork 0
/
openapi-spec.yaml
263 lines (256 loc) · 6.87 KB
/
openapi-spec.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
openapi: 3.0.1
info:
title: Ampelmännchen traffic light API
description: This is the documentation for the Ampelmann traffic light REST endpoints.
contact:
email: git@jackhiggins.ie
license:
name: MIT Licence
url: 'https://github.com/skhg/traffic-light-controller/blob/master/LICENSE'
version: latest
externalDocs:
description: Project documentation
url: 'https://github.com/skhg/traffic-light-controller/'
tags:
- name: web
description: Loads web pages
- name: lights
description: Control or query the lights
- name: music
description: Control or query info related to the song and current tempo
- name: status
description: General system status information
paths:
/:
get:
tags:
- web
summary: Load the web application
responses:
'200':
description: Webapp body response
content:
text/html:
example:
latestFile:
externalValue: 'https://raw.githubusercontent.com/skhg/traffic-light-controller/master/webapp/index.html'
/api/red:
get:
tags:
- lights
summary: Get the red light status
responses:
'200':
description: Got the status
content:
application/json:
schema:
type: object
properties:
red:
type: boolean
put:
tags:
- lights
summary: Put on the red light (Roxanne)
responses:
'204':
description: Turned the light on
delete:
tags:
- lights
summary: Switch off the red light
responses:
'204':
description: Switched the light off
/api/green:
get:
tags:
- lights
summary: Get the green light status
responses:
'200':
description: Got the status
content:
application/json:
schema:
type: object
properties:
red:
type: boolean
put:
tags:
- lights
summary: Switch on the green light
responses:
'204':
description: Turned the light on
delete:
tags:
- lights
summary: Switch off the green light
responses:
'204':
description: Switched the light off
/api/party:
get:
tags:
- lights
summary: Get the party mode status
responses:
'200':
description: Got the status
content:
application/json:
schema:
type: object
properties:
party:
type: boolean
put:
tags:
- lights
summary: Get the party started
responses:
'204':
description: The lights will have started pulsing
delete:
tags:
- lights
summary: Stop the party
responses:
'204':
description: The lights will remain in their last state and will stop pulsing
/api/tempo:
get:
tags:
- music
summary: Get the current tempo (Song BPM)
responses:
'200':
description: Got the status
content:
application/json:
schema:
type: object
properties:
bpm:
type: integer
example: 99
put:
tags:
- music
summary: Set the current tempo (Song BPM)
requestBody:
required: true
content:
application/json:
schema:
properties:
bpm:
type: integer
description: New BPM value
example: 120
responses:
'204':
description: Set the BPM
/api/song:
get:
tags:
- music
summary: Get the currently playing track details
responses:
'200':
description: Got the track details
content:
application/json:
schema:
type: object
properties:
title:
type: string
example: 'Exits'
artist:
type: string
example: 'Foals'
album:
type: string
example: 'Part 1 Everything Not Saved Will Be Lost'
put:
tags:
- music
summary: Set the currently playing track details
requestBody:
required: true
content:
application/json:
schema:
type: object
properties:
title:
type: string
example: 'Parfum thérémine - Version acoustique'
artist:
type: string
example: 'LImpératrice'
album:
type: string
example: 'Odyssée (Version acoustique)'
responses:
'204':
description: Set the track details
delete:
tags:
- music
summary: Clear the currently playing track
responses:
'204':
description: Current track details cleared
/api/status:
get:
tags:
- status
summary: Get all the current system status details.
description: This is a combination of all other GET responses, plus some additional fields.
responses:
'200':
description: Got the system status
content:
application/json:
schema:
type: object
properties:
bpm:
type: integer
example: 110
green:
type: boolean
red:
type: boolean
party:
type: boolean
title:
type: string
example: 'Parfum thérémine - Version acoustique'
artist:
type: string
example: 'LImpératrice'
album:
type: string
example: 'Odyssée (Version acoustique)'
redTemperature:
type: number
example: 20.2
greenTemperature:
type: number
example: 21.2
greenHumidity:
type: number
example: 53
redHumidity:
type: number
example: 56
servers:
- url: 'http://traffic-light.fritz.box'
variables: {}
description: Traffic Light on LAN