-
Notifications
You must be signed in to change notification settings - Fork 1
/
api-bf.yaml
516 lines (508 loc) · 13.6 KB
/
api-bf.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
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
openapi: 3.0.3
info:
title: BUPT Software Engineering Homework Server-Frontend API
description: BUPT Software Engineering Homework Server-Frontend API
version: 1.0.0
servers:
- url: "http://localhost:11451/api"
description: Local server
security:
- sessionAuth: []
paths:
/login:
post:
tags:
- Authorization
summary: Login as admin
parameters:
- in: query
name: no-csrf # If the server doesn't implement CSRF token, add this parameter to disable CSRF token
schema:
type: boolean
description: Disable CSRF token
requestBody:
required: true
content:
application/json:
schema:
type: object
properties:
username:
type: string
example: admin
password:
type: string
example: admin
responses:
"200":
description: Login successfully
headers:
Set-Cookie:
schema:
type: string
example: session=abcde12345; Path=/
content:
application/json:
schema:
type: object
properties:
username:
type: string
example: admin
csrf_token: # Optional: anti-CSRF token
type: string
example: abcde12345
role:
type: string
enum:
- manager
- checkout
- AC admin
"401":
description: Login failed
content:
application/json:
schema:
$ref: "#/components/schemas/error_response"
/logout:
post:
tags:
- Authorization
security:
- sessionAuth: []
parameters:
- in: header
name: X-CSRF-Token
schema:
type: string
example: abcde12345 # Optional: anti-CSRF token
description: CSRF token
summary: Logout
responses:
"204":
description: Logout successfully
headers:
Set-Cookie:
schema:
type: string
example: session=; Path=/
"401":
description: Not logged in
content:
application/json:
schema:
$ref: "#/components/schemas/error_response"
/admin/device:
put:
tags:
- Administrate
summary: Add device
security:
- sessionAuth: []
parameters:
- in: header
name: X-CSRF-Token
schema:
type: string
example: abcde12345 # Optional: anti-CSRF token
description: CSRF token
requestBody:
content:
application/json:
schema:
type: object
properties:
room:
type: string
example: 2-233
public_key:
type: string # RSA 4096
responses:
"200":
description: Add device successfully
content:
application/json:
schema:
type: object
properties:
room:
type: string
example: 2-233 # same as the input
"401":
description: Unauthorized
content:
application/json:
schema:
$ref: "#/components/schemas/error_response"
delete:
tags:
- Administrate
summary: Remove device
security:
- sessionAuth: []
parameters:
- in: header
name: X-CSRF-Token
schema:
type: string
example: abcde12345 # Optional: anti-CSRF token
description: CSRF token
requestBody:
content:
application/json:
schema:
type: object
properties:
room:
type: string
example: 2-233
responses:
"200":
description: Remove device successfully
content:
application/json:
schema:
type: object
properties:
room:
type: string
example: 2-233 # same as the input
"401":
description: Unauthorized
content:
application/json:
schema:
$ref: "#/components/schemas/error_response"
/admin/devices:
get:
tags:
- Administrate
summary: Get all available devices
security:
- sessionAuth: []
parameters:
- in: header
name: X-CSRF-Token
schema:
type: string
example: abcde12345 # Optional: anti-CSRF token
description: CSRF token
responses:
"200":
description: Get devices successfully
content:
application/json:
schema:
type: array
items:
type: string
example: 2-233
"401":
description: Unauthorized
content:
application/json:
schema:
$ref: "#/components/schemas/error_response"
/admin/device/{room_id}:
post:
tags:
- Administrate
summary: Control device
security:
- sessionAuth: []
parameters:
- in: path
name: room_id
schema:
type: string
example: 2-233
required: true
description: Room ID
- in: header
name: X-CSRF-Token
schema:
type: string
example: abcde12345 # Optional: anti-CSRF token
description: CSRF token
requestBody:
content:
application/json:
schema:
$ref: "#/components/schemas/request_entry"
responses:
"200":
description: Control successfully
content:
application/json:
schema:
type: array
items:
type: string
example: 2-233
"401":
description: Unauthorized
content:
application/json:
schema:
$ref: "#/components/schemas/error_response"
/status/{room_id}:
get:
tags:
- Data Query
summary: Get status of a device
security:
- sessionAuth: []
parameters:
- in: path
name: room_id
schema:
type: string
example: 2-233
required: true
description: Room ID
- in: header
name: X-CSRF-Token
schema:
type: string
example: abcde12345 # Optional: anti-CSRF token
description: CSRF token
responses:
"200":
description: Get status successfully
content:
application/json:
schema:
type: object
properties:
room:
type: string
example: 2-233
required: true
temperature:
type: integer
example: 26
required: true
wind_speed:
type: integer
example: 3
required: true
mode:
type: string
example: cold
required: true
sweep:
type: boolean
example: true
required: true
is_on:
type: boolean
example: true
required: true
last_update:
type: string
example: 2023-09-18T11:45:14+08:00 # ISO 8601
required: true
"401":
description: Unauthorized
content:
application/json:
schema:
$ref: "#/components/schemas/error_response"
/status:
get:
tags:
- Data Query
summary: Get status of all devices
security:
- sessionAuth: []
parameters:
- in: header
name: X-CSRF-Token
schema:
type: string
example: abcde12345 # Optional: anti-CSRF token
description: CSRF token
responses:
"200":
description: Get status successfully
content:
application/json:
schema:
type: array
items:
type: object
properties:
room:
type: string
example: 2-233
is_on:
type: boolean
example: true
"401":
description: Unauthorized
content:
application/json:
schema:
$ref: "#/components/schemas/error_response"
/room/check_in:
post:
tags:
- Room
summary: Check-in a room
security:
- sessionAuth: []
parameters:
- in: header
name: X-CSRF-Token
schema:
type: string
example: abcde12345 # Optional: anti-CSRF token
description: CSRF token
requestBody:
content:
application/json:
schema:
type: object
properties:
room:
type: string
example: 2-233
required: true
temperature:
type: integer
example: 26
required: true
responses:
"200":
description: Check-in successfully
content:
application/json:
schema:
type: object
properties:
room:
type: string
example: 2-233 # same as the input
required: true
"401":
description: Unauthorized
content:
application/json:
schema:
$ref: "#/components/schemas/error_response"
/room/check_out:
post:
tags:
- Room
summary: Check-out a room
security:
- sessionAuth: []
parameters:
- in: header
name: X-CSRF-Token
schema:
type: string
example: abcde12345 # Optional: anti-CSRF token
description: CSRF token
requestBody:
content:
application/json:
schema:
type: object
properties:
room:
type: string
example: 2-233
required: true
responses:
"200":
description: Check-out successfully
content:
application/json:
schema:
type: object
properties:
room:
type: string
example: 2-233 # same as the input
required: true
report:
$ref: "#/components/schemas/report_data"
"401":
description: Unauthorized
content:
application/json:
schema:
$ref: "#/components/schemas/error_response"
components:
securitySchemes:
sessionAuth:
type: apiKey
in: cookie # Optional: use CSRF token, header = X-CSRF-Token
name: session
schemas:
error_response:
type: object
properties:
error_code:
type: integer
example: 100
request_entry:
type: object
properties:
operation:
type: string
example: start
# start, stop, temperature, wind_speed, mode, sweep
required: true
data:
type: string
example: 26
# different for operations
required: true
report_data:
type: object
properties:
total_cost:
type: integer
example: 114514
total_time:
type: integer
example: 1919810
details:
type: array
items:
- type: object
properties:
start_time:
type: string
example: 2023-09-18T11:45:14+08:00 # ISO 8601
required: true
end_time:
type: string
example: 2023-09-19T11:45:14+08:00 # ISO 8601
required: true
temperature:
type: integer
example: 26
required: true
wind_speed:
type: integer
example: 3
required: true
mode:
type: string
example: cold
required: true
sweep:
type: boolean
example: true
required: true
duration:
type: integer
example: 86400 # seconds
required: true
cost:
type: integer
example: 114514
required: true