-
Notifications
You must be signed in to change notification settings - Fork 9
/
Qlue-IPFront-1.0.0-swagger.yaml
551 lines (546 loc) · 14.3 KB
/
Qlue-IPFront-1.0.0-swagger.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
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
openapi: 3.0.0
servers:
# Added by API Auto Mocking Plugin
# Added by API Auto Mocking Plugin
# Added by API Auto Mocking Plugin
- description: SwaggerHub API Auto Mocking
url: https://virtserver.swaggerhub.com/Qlue/IPFront/1.0.0
- description: SwaggerHub API Auto Mocking
url: https://qule.ipfront.co.jp/
- description: ETown Development Server
url: https://dev-api-etown.qlue.id/
info:
description: This is a Documentation API, to integrated Etown Township Management System with Ai computer vision provide by IP Front
version: "1.0.0"
title: Integration API between IP Front Cloud Server and Etown
contact:
email: andre@qlue.id
license:
name: Apache 2.0
url: 'http://www.apache.org/licenses/LICENSE-2.0.html'
tags:
- name: IPFront
description: API Interface on DM Server
- name: ETown
description: API for IP Front Cloud Integration(Server to Server)
- name: Mobile
description: API for Mobile Android and IOS App
paths:
/GetStatus:
get:
tags:
- IPFront
summary: Get the status of device Jetson Nano including the Cameras
operationId: getStatus
description: |
By passing in the appropriate options, you can get the device status,
registration status and the online status
parameters:
- name: params
in: query
required: true
content:
application/json:
schema:
type: object
properties:
JetsonID:
type: string
responses:
'200':
description: Result OK
content:
application/json:
schema:
$ref: '#/components/schemas/DeviceStatus'
'400':
description: Bad Request
'500':
description: Parameter Error
/RegisterJetsonboxid:
post:
tags:
- IPFront
summary: Register Houseid and Password to DMServer
operationId: regDevice
description: |
By passing in the appropriate options, you can search for
available inventory in the system
parameters:
- name: params
in: query
required: true
schema:
type: object
properties:
jetson_uuid:
type: "string"
username:
type: "string"
clusterId:
type: "string"
houseId:
type: "string"
responses:
'200':
description: Result OK
'400':
description: Bad Request
'500':
description: Parameter Error
/GetRTSPURL:
get:
tags:
- IPFront
summary: Get the rtsp link of each camera
operationId: getRTSP
description: |
By passing in the appropriate options, you can search for
available inventory in the system
parameters:
- name: params
in: query
required: true
schema:
type: object
properties:
jetson_uuid:
type: "string"
cameraId:
type: "string"
responses:
'200':
description: Result OK
'400':
description: Bad Request
'500':
description: Parameter Error
/StopRTSP:
get:
tags:
- IPFront
summary: Stop the rtsp link of each camera
operationId: stopRTSP
description: |
By passing in the appropriate options, you can search for
available inventory in the system
parameters:
- name: params
in: query
required: true
schema:
type: object
properties:
JetsonID:
type: object
properties:
jetson_id:
type: "string"
camera_id:
type: "string"
responses:
'200':
description: Result OK
'400':
description: Bad Request
'500':
description: Parameter Error
/SetCamera:
post:
tags:
- IPFront
summary: Set parameter to the specific camera based on applied feature
operationId: setCamera
description: Adds an item to the system
parameters:
- name: params
in: query
required: true
schema:
type: object
properties:
jetson_id:
type: "string"
responses:
'200':
description: Result OK
'400':
description: Bad Request
'500':
description: Parameter Error
/api/device/alert:
post:
tags:
- ETown
summary : Send device online/offline status to user via etown
operationId: deviceAlert
description: send alert related to device online offline status
responses:
'201':
description: alert created
'400':
description: 'invalid input, object invalid'
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/DeviceAlert'
description: Parameter needed to create cameras alert to ETown
/api/device/camera/alert:
post:
tags:
- ETown
summary : Send camera online/offline status to user via etown
operationId: cameraAlert
description: Adds an item to the system
responses:
'201':
description: alert created
'400':
description: 'invalid input, object invalid'
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/CameraAlert'
description: Parameter needed to create cameras alert to ETown
/api/device/camera/feature/alert:
post:
tags:
- ETown
summary : Send notification related to ai recognition to alert user via etown
operationId: featureAlert
description: Adds an item to the system
responses:
'201':
description: alert created
'400':
description: 'invalid input, object invalid'
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/FeatureAlert'
description: Parameter needed to create cameras alert to ETown
/device/list:
get:
tags:
- Mobile
summary: Get the device list that registered with the house
operationId: deviceList
description: |
By passing in the appropriate options, you can list for
available device in the house
parameters:
- name: params
in: query
required: true
content:
application/json:
schema:
type: object
properties:
houseId:
type: string
responses:
'200':
description: search results matching criteria
content:
application/json:
schema:
$ref: '#/components/schemas/DeviceList'
'400':
description: bad input parameter
/device/camera/list:
get:
tags:
- Mobile
summary: Get the camera list from the device
operationId: cameraList
description: |
By passing in the appropriate options, you can list for
available camera in the house
parameters:
- name: params
in: query
required: true
content:
application/json:
schema:
type: object
properties:
jetson_uuid:
type: string
responses:
'200':
description: search results matching criteria
content:
application/json:
schema:
$ref: '#/components/schemas/CameraList'
'400':
description: bad input parameter
/device/camera/stream:
get:
tags:
- Mobile
summary: Get the camera stream that connected to device
operationId: cameraStream
description: |
By passing in the appropriate options, you can list for
available camera in the house
parameters:
- name: params
in: query
required: true
content:
application/json:
schema:
type: object
properties:
jetson_uuid:
type: string
cameraId:
type: string
responses:
'200':
description: search results matching criteria
content:
application/json:
schema:
$ref: '#/components/schemas/CameraStream'
'400':
description: bad input parameter
/device/camera/alert/history:
get:
tags:
- Mobile
summary: Get the rtsp link of each camera
operationId: cameraAlertHistory
description: |
By passing in the appropriate options, you can search for
available inventory in the system
parameters:
- name: params
in: query
required: true
schema:
type: object
properties:
jetson_uuid:
type: "string"
responses:
'200':
description: search results matching criteria
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/CameraParam'
'400':
description: bad input parameter
components:
schemas:
DeviceStatus:
type: object
required:
- sn
- firmware
- regStatus
- lastOnline
- noCamera
- Cameras
properties:
sn:
type: string
example: 0904H210008
firmware:
type: string
example: 1.200.30
regStatus:
type: string
example: Registered
lastOnline:
type: string
format: date-time
example: '2023-11-29T09:12:33.001Z'
noCamera:
type: integer
example: 3
cameras:
$ref: '#/components/schemas/Cameras'
Cameras:
type: array
items:
type: object
properties:
no:
type: integer
id:
type: string
status:
type: string
lastOnline:
type: string
format: date-time
example:
- no: 1
id: 9a48824e-829d-11ee-b962-0242ac120002
status: online
lastOnline: '2023-11-29T09:12:33.001Z'
- no: 2
id: bb791d8e-829d-11ee-b962-0242ac120002
status: online
lastOnline: '2023-11-29T09:12:33.001Z'
- no: 3
id: c79794c4-829d-11ee-b962-0242ac120002
status: online
lastOnline: '2023-11-29T09:12:33.001Z'
CameraParam:
type: object
required:
- jetson_uuid
- cameraNo
- CameraId
- feature
properties:
jetson_uuid:
type: string
format: uuid
example: d290f1ee-6c54-4b01-90e6-d701748f0851
cameraNo:
type: integer
example: 1
cameraId:
type: string
example: 9a48824e-829d-11ee-b962-0242ac12000
feature:
type: string
example: fire detection
coordinates:
$ref: '#/components/schemas/CameraRoi'
CameraRoi:
type: string
example:
- 0,0
- 100,0
- 100,100
- 0,100
FeatureAlert:
type: object
required:
- sn
properties:
sn:
type: string
example: 0904H210008
cameraId:
type: string
example: c79794c4-829d-11ee-b962-0242ac120002
timestamp:
type: string
format: date-time
example: '2023-11-29T09:12:33.001Z'
confidence:
type: number
example: 0.67
alert:
type: string
example: 'intrusion'
subAlert:
type: string
example: 'person'
photoUrl:
type: string
example: 'video'
videoUrl:
type: string
format: url
example: 'https://ipfront.com'
DeviceAlert:
type: object
required:
- jetson_uuid
properties:
jetson_uuid:
type: string
format: uuid
example: d290f1ee-6c54-4b01-90e6-d701748f0851
status:
type: string
example: offline
timestamp:
type: string
format: date-time
example: '2023-11-29T09:12:33.001Z'
CameraAlert:
type: object
required:
- jetson_uuid
properties:
jetson_uuid:
type: string
format: uuid
example: d290f1ee-6c54-4b01-90e6-d701748f0851
camera_id:
type: string
example: 9a48824e-829d-11ee-b962-0242ac120002
status:
type: string
example: offline
timestamp:
type: string
format: date-time
example: '2023-11-29T09:12:33.001Z'
DeviceList:
type : array
items:
type: object
properties:
jetson_uuid:
type: string
example:
- no: 1
jetson_uuid: 9a48824e-829d-11ee-b962-0242ac120002
status: online
- no: 2
jetson_uuid: bb791d8e-829d-11ee-b962-0242ac120002
status: online
- no: 3
jetson_uuid: c79794c4-829d-11ee-b962-0242ac120002
status: online
CameraList:
type : array
items:
type: object
properties:
no:
type: integer
id:
type: string
status:
type: string
example:
- no: 1
id: 9a48824e-829d-11ee-b962-0242ac120002
status: online
- no: 2
id: bb791d8e-829d-11ee-b962-0242ac120002
status: online
- no: 3
id: c79794c4-829d-11ee-b962-0242ac120002
status: online
CameraStream:
type: object
properties:
jetson_uuid:
type: string
format: uuid
example: d290f1ee-6c54-4b01-90e6-d701748f0851
status:
type: string
example: online
rtsp:
type: string
example: 'rtsp://rtsp.ipfont.com/'