-
Notifications
You must be signed in to change notification settings - Fork 1
/
swagger-local-api.yaml
520 lines (483 loc) · 13 KB
/
swagger-local-api.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
517
518
519
520
openapi: 3.0.0
servers:
# Added by API Auto Mocking Plugin
- description: SwaggerHub API Auto Mocking
url: https://virtserver.swaggerhub.com/lucasdietrich/caniot-local-api/1.0.0
- description: Caniot stm32f429zi controller
url: http://192.168.10.240:80/
info:
description: This is a simple API
version: "1.0.0"
title: Simple Inventory API
contact:
email: [email protected]
license:
name: Apache 2.0
url: 'http://www.apache.org/licenses/LICENSE-2.0.html'
tags:
- name: general
description: General operations
- name: devices
description: Device operations (BLE, CAN, etc.)
- name: devices-caniot
description: CANIOT general informations
- name: caniot
description: CANIOT Low Level operations
security:
- BasicAuth: []
paths:
/devices/garage:
get:
summary: Get the garage doors positions
tags:
- devices
responses:
'200':
description: The garage doors positions
content:
application/json:
schema:
$ref: '#/components/schemas/GarageInfo'
'404':
description: Garage Device not found
post:
summary: Command garage doors
tags:
- devices
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/GarageCommands'
responses:
'200':
description: OK
'400':
description: Malformed command
/devices/caniot:
get:
summary: Retrieves caniot devices measurements
tags:
- "devices-caniot"
responses:
'200':
description: OK
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/CANIOTInfo'
/devices/caniot/{did}:
get:
tags:
- "devices-caniot"
parameters:
- $ref: '#/components/parameters/DeviceID'
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/DeviceInfo'
'404':
description: CANIOT device not found
/devices/caniot/{did}/attribute/{attr}:
parameters:
- $ref: '#/components/parameters/DeviceID'
- $ref: "#/components/parameters/AttributeAddr"
put:
tags:
- "caniot"
requestBody:
required: true
description: Attribute value to write in
content:
application/json:
schema:
type: object
required:
- userName
properties:
value:
type: integer
example: 67
minimum: 0
maximum: 65535
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/AttributeResp'
'404':
description: CANIOT device not found
'400':
description: Request malformed
get:
tags:
- "caniot"
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/AttributeResp'
'404':
description: CANIOT device not found
/devices/caniot/{did}/endpoint/blc/command:
parameters:
- $ref: '#/components/parameters/DeviceID'
post:
tags:
- "caniot"
requestBody:
required: true
description: Command to send
content:
application/json:
schema:
oneOf:
- $ref: "#/components/schemas/class0_blc"
- $ref: "#/components/schemas/class1blc"
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: "#/components/schemas/class0_blc_teleme"
'400':
description: Request malformed
'500':
description: Server error (memory, args, ...)
/devices/caniot/{did}/endpoint/{ep}/command:
parameters:
- $ref: '#/components/parameters/DeviceID'
- $ref: '#/components/parameters/EndpointID'
post:
tags:
- "caniot"
requestBody:
required: true
description: Command to send
content:
application/json:
schema:
$ref: "#/components/schemas/CaniotGenericCommand"
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: "#/components/schemas/CaniotGenericTelemetry"
'404':
description: CANIOT device or endpoint not found
'400':
description: Request malformed
'500':
description: Server error (memory, args, ...)
/devices/caniot/{did}/endpoint/{ep}/telemetry:
parameters:
- $ref: '#/components/parameters/DeviceID'
- $ref: '#/components/parameters/EndpointID'
get:
tags:
- "caniot"
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: "#/components/schemas/class0_blc_teleme"
'404':
description: CANIOT device or endpoint not found
'400':
description: Request malformed
components:
# Security
securitySchemes:
BasicAuth: # <-- arbitrary name for the security scheme
type: http
scheme: basic
schemas:
DeviceInfo:
description: CANIOT device informations
type: object
properties:
did:
type: integer
example: 24
last_seen:
type: integer
example: 1653726896
AttributeResp:
description: CANIOT device attribute informations
type: object
properties:
status:
type: string
example: "OK"
caniot_error:
type: integer
example: 0
duration:
type: integer
example: 167
key:
type: integer
example: 8208
key_repr:
type: string
example: "0x2010"
value:
type: integer
example: 0
value_repr:
type: string
example: "0x0000"
CANIOTInfo:
description: CANIOT device informations
type: object
properties:
id:
type: integer
example: 24
timestamp:
type: integer
example: 1653726896
temperatures:
type: array
items:
type: object
properties:
repr:
type: string
example: "24.20"
value:
type: integer
example: 2400
sens_type:
type: integer
example: 4
dio:
type: integer
example: 240
XPSCommand:
description: CANIOT device "Complex Digital Command" XPS command
type: string
enum: [none, set, set_off, toggle, pulse_on, pulse_off, pulse_cancel]
TSCommand:
description: CANIOT device "Two State" command
type: string
enum: [none, set, reset, toggle]
SSCommand:
description: CANIOT device "One Action" command
type: string
enum: [none, do]
DoorStatus:
description: Garage device door status
type: string
enum: [open, close]
GarageInfo:
description: Garage door informations
type: object
properties:
left_door:
$ref: "#/components/schemas/DoorStatus"
right_door:
$ref: "#/components/schemas/DoorStatus"
gate:
$ref: "#/components/schemas/DoorStatus"
_caniot:
$ref: "#/components/schemas/CANIOTInfo"
GarageCommands:
description: Garage door commands
type: object
properties:
left_door:
$ref: "#/components/schemas/SSCommand"
right_door:
$ref: "#/components/schemas/SSCommand"
class0_blc_teleme:
description: Board level telemetry
type: object
properties:
timestamp:
type: integer
example: 1653726896
duration:
description: "Duration in mc"
type: integer
example: 6
dio:
type: integer
example: 240
pdio:
type: integer
example: 0
temperatures:
type: array
items:
type: object
properties:
repr:
type: string
example: "24.20"
value:
type: integer
example: 2400
sens_type:
type: integer
example: 4
class_common_blc:
description: CANIOT CLASS Commong BLC Command
type: object
properties:
hardware_reset:
description: "Hardware Reset"
type: boolean
default: false
software_reset:
description: "Software Reset"
type: boolean
default: false
wdt_reset:
description: "Reset by Watchdog"
type: boolean
default: false
wdt:
description: "Watchdog configuration"
$ref: "#/components/schemas/TSCommand"
config_reset:
description: "Configuration reset"
type: boolean
default: false
class0_blc:
description: CANIOT CLASS 0 BLC Command
type: object
properties:
class:
type: integer
example: 0
command:
description: CANIOT CLASS 0 BLC Command
type: object
properties:
coc1:
$ref: "#/components/schemas/XPSCommand"
coc2:
$ref: "#/components/schemas/XPSCommand"
crl1:
$ref: "#/components/schemas/XPSCommand"
crl2:
$ref: "#/components/schemas/XPSCommand"
common:
$ref: "#/components/schemas/class_common_blc"
class1blc:
description: CANIOT CLASS 1 BLC Command
type: object
properties:
class:
type: integer
example: 0
command:
description: CANIOT CLASS 1 BLC Command
type: object
properties:
pc0:
$ref: "#/components/schemas/XPSCommand"
pc1:
$ref: "#/components/schemas/XPSCommand"
pc2:
$ref: "#/components/schemas/XPSCommand"
pc3:
$ref: "#/components/schemas/XPSCommand"
pd0:
$ref: "#/components/schemas/XPSCommand"
pd1:
$ref: "#/components/schemas/XPSCommand"
pd2:
$ref: "#/components/schemas/XPSCommand"
pd3:
$ref: "#/components/schemas/XPSCommand"
pd4:
$ref: "#/components/schemas/XPSCommand"
eio0:
$ref: "#/components/schemas/XPSCommand"
eio1:
$ref: "#/components/schemas/XPSCommand"
eio2:
$ref: "#/components/schemas/XPSCommand"
eio3:
$ref: "#/components/schemas/XPSCommand"
eio4:
$ref: "#/components/schemas/XPSCommand"
eio5:
$ref: "#/components/schemas/XPSCommand"
eio6:
$ref: "#/components/schemas/XPSCommand"
eio7:
$ref: "#/components/schemas/XPSCommand"
pb0:
$ref: "#/components/schemas/XPSCommand"
pe0:
$ref: "#/components/schemas/XPSCommand"
pe1:
$ref: "#/components/schemas/XPSCommand"
common:
$ref: "#/components/schemas/class_common_blc"
CaniotGenericCommand:
description: CANIOT generic command
type: array
example: [255, 17, 254, 0, 0, 0, 0, 0]
items:
type: integer
minimum: 0
maximum: 255
minItems: 0
maxItems: 8
CaniotGenericTelemetry:
description: CANIOT generic telemetry
type: array
example: [255, 17, 254, 0, 0, 0, 0, 0]
items:
type: integer
minimum: 0
maximum: 255
minItems: 0
maxItems: 8
parameters:
DeviceID:
name: did
in: path
description: Device ID
required: true
schema:
type: integer
minimum: 0
maximum: 63
example: 24
AttributeAddr:
name: attr
in: path
description: Attribute Address (in hexadecimal)
required: true
schema:
type: string
example: "2010"
EndpointID:
name: ep
in: path
description: Endpoint ID (app = 0, 1, 2, board control = 4)
required: true
schema:
type: integer
minimum: 0
maximum: 3
example: 0