forked from mohammedayub44/ObjectDetection
-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathswagger.yaml
667 lines (653 loc) · 22.2 KB
/
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
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
swagger: "2.0"
info:
description: This is the swagger file Crowd Counter that goes with Server Code
version: "1.0.0"
title: Swagger Rest Article
consumes:
- application/json
produces:
- application/json
basePath: /api
# Paths supported by the server application
paths:
/video:
get:
operationId: video.read_all
tags:
- Video
summary: Read all videos present sorted by Name
description: Read all videos present sorted by Name
responses:
200:
description: Successfully read video set operation
schema:
type: array
items:
properties:
id:
type: string
description: Id of the video
url:
type: string
description: URL of the video
duration:
type: string
description: Total Duration of the video
area:
type: string
description: In-scene area of the Video
units:
type: string
description: metric for in-scene video area
threshold:
type: string
description: NFPA Calculated max value for provided occupancy and video area
date_created:
type: string
description: Creation timestamp of the Video
last_updated:
type: string
description: Last Updated timestamp of the Video
vid_load_ref:
type: integer
description: Occupancy type id linked to this video
post:
operationId: video.create
tags:
- Video
summary: Create a video
description: Create a new video
parameters:
- name: video
in: body
description: Video to create
required: True
schema:
type: object
required:
- url
- vid_load_ref
properties:
url:
type: string
description: URL of the video to create
duration:
type: string
description: Total Duration of the video
area:
type: string
description: In-scene area of the video
units:
type: string
description: metric for in-scene video area
threshold:
type: string
description: NFPA Calculated max value for provided occupancy and video area
date_created:
type: string
description: Creation Timestamp of the video
last_updated:
type: string
description: Last Updated timestamp of the Video
vid_load_ref:
type: integer
description: Occupancy type id linked to this video
responses:
201:
description: Successfully created video
schema:
properties:
id:
type: string
description: Id of the video
url:
type: string
description: URL of the video
duration:
type: string
description: Total Duration of the video
area:
type: string
description: In-scene area of the video
units:
type: string
description: metric for in-scene video area
threshold:
type: string
description: NFPA Calculated max value for provided occupancy and video area
date_created:
type: string
description: Creation Timestamp of the video
last_updated:
type: string
description: Last Updated timestamp of the Video
vid_load_ref:
type: integer
description: Occupancy type id linked to this video
/video/{video_id}:
get:
operationId: video.read_one
tags:
- Video
summary: Read details of one video
description: Read details of one video
parameters:
- name: video_id
in: path
description: Id of the video to get fetch
type: integer
required: True
responses:
200:
description: Successfully read video from data
schema:
type: object
properties:
id:
type: string
description: Id of the video
url:
type: string
description: URL of the video
duration:
type: string
description: Total Duration of the video
area:
type: string
description: In-scene area of the video
units:
type: string
description: metric for in-scene video area
threshold:
type: string
description: NFPA Calculated max value for provided occupancy and video area
date_created:
type: string
description: Creation Timestamp of the video
last_updated:
type: string
description: Last Updated timestamp of the Video
vid_load_ref:
type: integer
description: Occupancy type id linked to this video
put:
operationId: video.update
tags:
- Video
summary: Update a video
description: Update a video
parameters:
- name: video_id
in: path
description: Id the video to update
type: integer
required: True
- name: video
in: body
schema:
type: object
required:
- id
- url
- vid_load_ref
properties:
id:
type: integer
description: ID of the video
url:
type: string
description: URL of the video
duration:
type: string
description: Total Duration of the video
area:
type: string
description: In-scene area of the video
units:
type: string
description: metric for in-scene video area
threshold:
type: string
description: NFPA Calculated max value for provided occupancy and video area
date_created:
type: string
description: Creation Timestamp of the video
last_updated:
type: string
description: Last Updated timestamp of the Video
vid_load_ref:
type: integer
description: Occupancy type id linked to this video
responses:
200:
description: Successfully updated video
schema:
properties:
id:
type: string
description: Id of the video
url:
type: string
description: URL of the video
duration:
type: string
description: Total Duration of the video
area:
type: string
description: In-scene area of the video
units:
type: string
description: metric for in-scene video area
threshold:
type: string
description: NFPA Calculated max value for provided occupancy and video area
date_created:
type: string
description: Creation Timestamp of the video
last_updated:
type: string
description: Last Updated timestamp of the Video
vid_load_ref:
type: integer
description: Occupancy type id linked to this video
delete:
operationId: video.delete
tags:
- Video
summary: Delete a video from the list
description: Delete a video
parameters:
- name: video_id
in: path
type: integer
description: Id of the video to delete
required: true
responses:
200:
description: Successfully deleted a video
# Snapshot related Endpoints
/snapshot:
get:
operationId: snapshot.read_all
tags:
- Snapshot
summary: Read all snapshots sorted by ID
description: Read all snapshots sorted by ID
responses:
200:
description: Successfully read snapshot operation
schema:
type: array
items:
properties:
id:
type: string
description: Id of the snapshot
snap:
type: string
description: Static File Location of the snapshot in jpeg format
heatmap:
type: string
description: Static File Location of the snapshot in jpeg format
pred_class:
type: string
description: Predicted Class from the Classification model
pred_count:
type: string
description: Predicted Count from the Crowd Detection model
pred_count_ssdcnet:
type: string
description: Predicted Count from SSDCNet model
date_clicked:
type: string
description: Timestamp of the snapshot clicked (Datetime format)
video_id_ref:
type: string
description: Video ID liked to this snapshot
# Reads all snapshots for a particular video
/snapshot/{video_id}:
get:
operationId: snapshot.read_all_from_video
tags:
- Snapshot
summary: Read all snapshots for a given video
description: Read all snapshots for a given video
parameters:
- name: video_id
in: path
description: Id of the video to get snapshots
type: integer
required: True
responses:
200:
description: Successfully read snapshots for given ID.
schema:
type: array
items:
properties:
id:
type: string
description: Id of the snapshot
snap:
type: string
description: Static File Location of the snapshot in jpeg format
heatmap:
type: string
description: Static File Location of the snapshot in jpeg format
pred_class:
type: string
description: Predicted Class from the Classification model
pred_count:
type: string
description: Predicted Count from the Crowd Detection model
pred_count_ssdcnet:
type: string
description: Predicted Count from SSDCNet model
date_clicked:
type: string
description: Timestamp of the snapshot clicked (Datetime format)
video_id_ref:
type: string
description: Video ID liked to this snapshot
# Reads or modifies one snapshot for a given video
/snapshot/{video_id}/{snapshot_id}:
get:
operationId: snapshot.read_one_from_video
tags:
- Snapshot
summary: Read one snapshot for a given video
description: Read one snapshot for a given video
parameters:
- name: video_id
in: path
description: Id of the video
type: integer
required: True
- name: snapshot_id
in: path
description: Id of the snapshot
type: integer
required: True
responses:
200:
description: Successfully read snapshot for given ID.
schema:
type: object
properties:
id:
type: string
description: Id of the snapshot
snap:
type: string
description: Static File Location of the snapshot in jpeg format
heatmap:
type: string
description: Static File Location of the snapshot in jpeg format
pred_class:
type: string
description: Predicted Class from the Classification model
pred_count:
type: string
description: Predicted Count from the Crowd Detection model
pred_count_ssdcnet:
type: string
description: Predicted Count from SSDCNet model
date_clicked:
type: string
description: Timestamp of the snapshot clicked (Datetime format)
video_id_ref:
type: string
description: Video ID liked to this snapshot
put:
operationId: snapshot.update
tags:
- Snapshot
summary: Update a Snapshot instance
description: Update a Snapshot instance
parameters:
- name: video_id
in: path
description: Id the video in reference
type: integer
required: True
- name: snapshot_id
in: path
description: Id the snapshot to update
type: integer
required: True
- name: snapshot
in: body
schema:
type: object
required:
- id
properties:
id:
type: string
description: Id of the snapshot
snap:
type: string
description: Static File Location of the snapshot in jpeg format
heatmap:
type: string
description: Static File Location of the snapshot in jpeg format
pred_class:
type: string
description: Predicted Class from the Classification model
pred_count:
type: string
description: Predicted Count from the Crowd Detection model
pred_count_ssdcnet:
type: string
description: Predicted Count from SSDCNet model
date_clicked:
type: string
description: Timestamp of the snapshot clicked (Datetime format)
responses:
200:
description: Successfully updated video
schema:
properties:
id:
type: string
description: Id of the snapshot
snap:
type: string
description: Static File Location of the snapshot in jpeg format
heatmap:
type: string
description: Static File Location of the snapshot in jpeg format
pred_class:
type: string
description: Predicted Class from the Classification model
pred_count:
type: string
description: Predicted Count from the Crowd Detection model
pred_count_ssdcnet:
type: string
description: Predicted Count from SSDCNet model
date_clicked:
type: string
description: Timestamp of the snapshot clicked (Datetime format)
delete:
operationId: snapshot.delete
tags:
- Snapshot
summary: Delete a snapshot from the list
description: Delete a snapshot from the list
parameters:
- name: video_id
in: path
type: integer
description: Id of the video in reference
required: true
- name: snapshot_id
in: path
type: integer
description: Id of the snapshot to delete
required: true
responses:
200:
description: Successfully deleted a video
# Get last week snapshots for a video
/snapshot/get_last_week/{video_id}:
get:
operationId: snapshot.get_last_week
tags:
- Snapshot
summary: Read all snapshots for one week interval
description: Read all snapshots for one week interval
parameters:
- name: video_id
in: path
description: Id of the video to get snapshots
type: integer
required: True
responses:
200:
description: Successfully read snapshots for given ID.
schema:
type: array
items:
properties:
id:
type: string
description: Id of the snapshot
snap:
type: string
description: Static File Location of the snapshot in jpeg format
heatmap:
type: string
description: Static File Location of the snapshot in jpeg format
pred_class:
type: string
description: Predicted Class from the Classification model
pred_count:
type: string
description: Predicted Count from the Crowd Detection model
pred_count_ssdcnet:
type: string
description: Predicted Count from SSDCNet model
date_clicked:
type: string
description: Timestamp of the snapshot clicked (Datetime format)
video_id_ref:
type: string
description: Video ID liked to this snapshot
# Get last month snapshots for a video
/snapshot/get_last_month/{video_id}:
get:
operationId: snapshot.get_last_month
tags:
- Snapshot
summary: Read all snapshots for one month interval
description: Read all snapshots for one month interval
parameters:
- name: video_id
in: path
description: Id of the video to get snapshots
type: integer
required: True
responses:
200:
description: Successfully read snapshots for given ID.
schema:
type: array
items:
properties:
id:
type: string
description: Id of the snapshot
snap:
type: string
description: Static File Location of the snapshot in jpeg format
heatmap:
type: string
description: Static File Location of the snapshot in jpeg format
pred_class:
type: string
description: Predicted Class from the Classification model
pred_count:
type: string
description: Predicted Count from the Crowd Detection model
pred_count_ssdcnet:
type: string
description: Predicted Count from SSDCNet model
date_clicked:
type: string
description: Timestamp of the snapshot clicked (Datetime format)
video_id_ref:
type: string
description: Video ID liked to this snapshot
# Get last day snapshots for a video
/snapshot/get_last_day/{video_id}:
get:
operationId: snapshot.get_last_day
tags:
- Snapshot
summary: Read all snapshots for one day interval
description: Read all snapshots for one day interval
parameters:
- name: video_id
in: path
description: Id of the video to get snapshots
type: integer
required: True
responses:
200:
description: Successfully read snapshots for given ID.
schema:
type: array
items:
properties:
id:
type: string
description: Id of the snapshot
snap:
type: string
description: Static File Location of the snapshot in jpeg format
heatmap:
type: string
description: Static File Location of the snapshot in jpeg format
pred_class:
type: string
description: Predicted Class from the Classification model
pred_count:
type: string
description: Predicted Count from the Crowd Detection model
pred_count_ssdcnet:
type: string
description: Predicted Count from SSDCNet model
date_clicked:
type: string
description: Timestamp of the snapshot clicked (Datetime format)
video_id_ref:
type: string
description: Video ID liked to this snapshot
# Get all data for Occupancytype
/occupancytype/all:
get:
operationId: occupancytype.read_all
tags:
- Occupancytype
summary: Returns all data for occupancy loads
description: Returns all data for occupancy loads
responses:
200:
description: Successfully returned occupancy info.
schema:
type: array
items:
properties:
id:
type: string
description: Id of the Occupancy
use:
type: string
description: Occupancy type
load_ft2:
type: string
description: Load measure in square feet
load_m2:
type: string
description: Load measure in square meter rounded to one decimal point