-
Notifications
You must be signed in to change notification settings - Fork 13
/
openapi.yaml
346 lines (346 loc) · 10.5 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
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
openapi: 3.0.0
servers:
- description: prod
url: https://noita-together.skyefullofbreeze.com/api
- description: dev
url: http://localhost:3000/api
info:
version: "1.0.0"
title: noita-together-api
description: Noita Together API for login/stats
paths:
/auth/login:
get:
tags:
- Authentication
description: Redirects the user to twitch authentication via OIDC
operationId: authLogin
parameters:
- in: query
name: deviceCode
description: 8 digit device code for device authorization
schema:
type: number
minLength: 8
maxLength: 8
responses:
'302':
description: Redirect to TWITCH login
headers:
Location:
schema:
type: string
/auth/code:
get:
tags:
- Authentication
description: Authorization Grant Flow Code endpoint from twitch
operationId: authCode
parameters:
- in: query
name: code
description: Authorization Grant Code
schema:
type: string
- in: query
name: state
description: Authorization flow state, sometimes is our device authorization code passed via login
schema:
type: string
responses:
'500':
description: Server Error
content:
'application/json':
schema:
type: object
properties:
error:
type: string
example: "Failed to retrieve tokens :("
'200':
description: Successful login when using device authorization flow. The user receives the tokens via the websocket connection
content:
'text/html':
schema:
type: string
example: "you can close this."
'302':
description: Redirect to TWITCH login
headers:
Location:
schema:
type: string
example: http://localhost:3000/?token=${accessToken}&refresh=${refreshToken}&expires_in=28800
/auth/refresh:
post:
tags:
- Authentication
summary: Refresh Access Token
parameters:
- in: header
name: Authorization
description: Refresh token, as 'Bearer $token'
schema:
type: string
responses:
'200':
description: Successful token refresh
content:
application/json:
schema:
type: object
properties:
token:
type: string
description: Access token
expires_in:
type: string
description: Token expiration in seconds from now
'401':
description: Unauthorized
content:
text/plain:
schema:
type: string
'404':
description: User Not Found
content:
text/plain:
schema:
type: string
'502':
description: Failed to get Twitch user data
content:
text/plain:
schema:
type: string
'500':
description: Failed to interface with the database
content:
text/plain:
schema:
type: string
# schemas:
# LightingSummary:
# type: object
# properties:
# zones:
# type: array
# items:
# $ref: '#/components/schemas/LightingZone'
# zoneStatus:
# type: array
# items:
# $ref: '#/components/schemas/LightingZoneStatus'
# description: ok
# LightingZone:
# type: object
# properties:
# id:
# type: string
# name:
# type: string
# deviceId:
# type: integer
# format: int32
# deviceType:
# type: string
# enum:
# - dimmer
# - switch
# zone:
# type: string
# LightingZoneStatus:
# type: object
# properties:
# id:
# type: string
# name:
# type: string
# lastUpdate:
# type: string
# format: date-time
# level:
# type: integer
# format: int32
# description: the status of the lighting zone.
# TemperatureSummary:
# type: object
# properties:
# zones:
# type: array
# items:
# $ref: '#/components/schemas/TemperatureZone'
# zoneStatus:
# type: array
# items:
# $ref: '#/components/schemas/TemperatueZoneStatus'
# description: ok
# TemperatureZone:
# type: object
# required:
# - id
# - name
# properties:
# id:
# type: integer
# format: int32
# description: the unique identifier for the zone
# name:
# type: string
# inputPosition:
# type: integer
# format: int32
# outputPosition:
# type: integer
# format: int32
# zone:
# type: string
# description: a single temperature zone
# TemperatueZoneStatus:
# type: object
# required:
# - id
# - timestamp
# - value
# properties:
# id:
# type: string
# description: the unique identifier for the zone
# name:
# type: string
# description: the name of the zone
# value:
# type: number
# format: double
# description: the temperature in the zone
# units:
# type: string
# description: the temperature units
# enum:
# - celsius
# - fahrenheit
# default: fahrenheit
# timestamp:
# type: string
# format: date-time
# description: the timestamp when the temperature was measured
# description: status of a single zone
# ApiResponse:
# type: object
# properties:
# code:
# type: integer
# format: int32
# message:
# type: string
# example: everything is ok
# HeaterState:
# type: object
# properties:
# id:
# type: string
# state:
# type: string
# DeviceState:
# type: object
# properties:
# id:
# type: string
# name:
# type: string
# lastUpdate:
# type: string
# format: date-time
# level:
# type: integer
# format: int32
# ForecastResponse:
# type: object
# properties:
# city:
# $ref: '#/components/schemas/City'
# values:
# type: array
# items:
# $ref: '#/components/schemas/Forecast'
# Forecast:
# type: object
# properties:
# date:
# type: string
# format: date-time
# pressure:
# type: number
# format: double
# humidity:
# type: integer
# format: int32
# windSpeed:
# type: number
# format: double
# clouds:
# type: integer
# format: int32
# temperature:
# $ref: '#/components/schemas/ForecastTemperature'
# weather:
# $ref: '#/components/schemas/WeatherForecast'
# City:
# type: object
# properties:
# id:
# type: integer
# format: int64
# name:
# type: string
# lat:
# type: number
# format: double
# lon:
# type: number
# format: double
# country:
# type: string
# ForecastTemperature:
# type: object
# properties:
# low:
# type: number
# format: double
# high:
# type: number
# format: double
# morning:
# type: number
# format: double
# day:
# type: number
# format: double
# evening:
# type: number
# format: double
# night:
# type: number
# format: double
# WeatherForecast:
# type: object
# properties:
# summary:
# type: string
# description:
# type: string
# icon:
# type: string
# DeviceRegistrationInfo:
# type: object
# properties:
# uri:
# type: string
# format: uri
# example: 'http://10.0.0.220:8080'
# id:
# type: string
# format: uuid
# example: 0729a580-2240-11e6-9eb5-0002a5d5c51b