{{ message }}
Repository navigation
Expand file tree
/
Copy pathapi.yaml
More file actions
executable file
·1309 lines (1296 loc) · 39.1 KB
/
Copy pathapi.yaml
File metadata and controls
executable file
·1309 lines (1296 loc) · 39.1 KB
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
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
openapi: 3.0.0
info:
version: 0.0.1
description: API for The Ocean Cleanup Labeling system
title: The Ocean Cleanup Label API
servers:
- url: http://localhost:8080/api/v1
description: Some example server
tags:
- name: external
description: These operations can be accessed by both internal users with
their personal access keys and by external parties if they have the
appropriate api keys.
- name: internal
description: These operations can only be used by internal employees, with
their personal access keys.
# security:
# - apiKey: []
# apiSecret: []
paths:
/image_sets:
get:
summary: List all the image sets in the database
tags:
- internal
operationId: handlers.image_sets.list_imagesets
parameters:
- name: page
in: query
required: false
description: Page of results to retrieve
schema:
type: integer
minimum: 1
example: 1
- name: per_page
in: query
required: false
description: Number of results to retrieve per page
schema:
type: integer
minimum: 1
example: 10
responses:
"200":
description: A paged array of image sets
content:
application/json:
schema:
$ref: "#/components/schemas/ImageSetList"
"401":
$ref: "#/components/responses/UnauthorizedError"
default:
$ref: "#/components/responses/Error"
post:
summary: Create a new image set
tags:
- internal
operationId: handlers.image_sets.add_imageset
requestBody:
description: New image set item
required: true
content:
application/json:
schema:
$ref: "#/components/schemas/NewImageSet"
responses:
"200":
description: The created image set
content:
application/json:
schema:
$ref: "#/components/schemas/CreatedImageSet"
"401":
$ref: "#/components/responses/UnauthorizedError"
"409":
$ref: "#/components/responses/ConflictError"
"422":
$ref: "#/components/responses/InvalidParameterError"
default:
$ref: "#/components/responses/Error"
/image_sets/{imageset_id}:
put:
summary: Change the status of an imageset
tags:
- internal
operationId: handlers.image_sets.change_status
parameters:
- name: imageset_id
in: path
required: true
description: The id of the image set
schema:
type: integer
requestBody:
description: The new status to set the image set to
required: true
content:
application/json:
schema:
type: object
required:
- new_status
properties:
new_status:
$ref: "#/components/schemas/ImageSetStatus"
responses:
"200":
description: Successfully changed the image set status
"401":
$ref: "#/components/responses/UnauthorizedError"
"404":
$ref: "#/components/responses/DoesNotExistError"
"409":
$ref: "#/components/responses/ConflictError"
default:
$ref: "#/components/responses/Error"
/image_sets/{imageset_id}/images:
get:
summary: Get a list of images for an image set.
tags:
- internal
operationId: handlers.image_sets.get_images
parameters:
- name: imageset_id
in: path
required: true
description: The id of the image set
schema:
type: integer
- name: page
in: query
required: false
description: Page of results to retrieve
schema:
type: integer
minimum: 1
example: 1
- name: per_page
in: query
required: false
description: Number of results to retrieve per page
schema:
type: integer
minimum: 1
example: 10
responses:
"200":
description: A paged array of images in the image set
content:
application/json:
schema:
$ref: "#/components/schemas/ImageList"
"401":
$ref: "#/components/responses/UnauthorizedError"
"404":
$ref: "#/components/responses/DoesNotExistError"
default:
$ref: "#/components/responses/Error"
post:
summary: Add images to an imageset
tags:
- internal
operationId: handlers.image_sets.add_images
parameters:
- name: imageset_id
in: path
required: true
description: The id of the image set
schema:
type: integer
requestBody:
description: A list of images to add to the image set. Image can be
provided either as internal ID or by blobstorage filepath.
required: true
content:
application/json:
schema:
type: array
items:
$ref: "#/components/schemas/NewImageToContainer"
responses:
"200":
description: Successfully added images to imageset
"401":
$ref: "#/components/responses/UnauthorizedError"
"404":
$ref: "#/components/responses/DoesNotExistError"
"409":
$ref: "#/components/responses/ConflictError"
default:
$ref: "#/components/responses/Error"
/images:
get:
summary: List all images in the system.
tags:
- internal
operationId: handlers.images.list_images
parameters:
- name: page
in: query
required: false
description: Page of results to retrieve
schema:
type: integer
minimum: 1
example: 1
- name: per_page
in: query
required: false
description: Number of results to retrieve per page
schema:
type: integer
minimum: 1
example: 100
responses:
"200":
description: A paged array of images
content:
application/json:
schema:
$ref: "#/components/schemas/ImageList"
"401":
$ref: "#/components/responses/UnauthorizedError"
default:
$ref: "#/components/responses/Error"
/images/{image_id}:
get:
summary: Get an image. If authenticated, this will redirect to the actual
image in blobstorage, with a SAS token for access.
tags:
- external
operationId: handlers.images.get_image_url
parameters:
- name: image_id
in: path
required: true
description: The id of the desired image
schema:
type: integer
responses:
"303":
description: Redirect to the location of the image
content:
application/json:
schema:
type: string
format: uri
example: https://toc.blob.core.windows.net/tss/uploads/20201012-DroneFootage/img00001.jpg?sv=etc...
headers:
Location:
description: The location where the image can be found, including
SAS token.
schema:
type: string
format: uri
example: https://toc.blob.core.windows.net/tss/uploads/20201012-DroneFootage/img00001.jpg?sv=etc...
"401":
$ref: "#/components/responses/UnauthorizedError"
"404":
$ref: "#/components/responses/DoesNotExistError"
default:
$ref: "#/components/responses/Error"
/images/{image_id}/objects:
get:
summary: Show the objects for a certain image
tags:
- internal
operationId: handlers.images.get_objects
parameters:
- name: image_id
in: path
required: true
description: The id of the desired image
schema:
type: integer
- name: campaigns
in: query
required: false
description: Optionally, list the IDs of campaigns you want the
objects. If multiple are provided, objects are returned for the
first campaign in the list for which objects exist for this image -
meaning only the objects from exactly one campaign will ever be
returned. If no campaign is provided, objects from any finished
campaign will be returned, prioritized by the most recent campaign.
schema:
type: array
items:
description: Campaign ID
type: integer
minimum: 0
responses:
"200":
description: A list of objects in this image set
content:
application/json:
schema:
type: array
items:
$ref: "#/components/schemas/Object"
"401":
$ref: "#/components/responses/UnauthorizedError"
"404":
$ref: "#/components/responses/DoesNotExistError"
default:
$ref: "#/components/responses/Error"
/campaigns:
get:
summary: List all the labeling campaigns in the database
tags:
- internal
operationId: handlers.campaigns.list_campaigns
parameters:
- name: page
in: query
required: false
description: Page of results to retrieve
schema:
type: integer
minimum: 1
example: 1
- name: per_page
in: query
required: false
description: Number of results to retrieve per page
schema:
type: integer
minimum: 1
example: 10
responses:
"200":
description: A paged array of labeling campaigns
content:
application/json:
schema:
$ref: "#/components/schemas/CampaignList"
"401":
$ref: "#/components/responses/UnauthorizedError"
default:
$ref: "#/components/responses/Error"
post:
summary: Create a new campaign
tags:
- internal
operationId: handlers.campaigns.add_campaign
requestBody:
description: New campaign item
required: true
content:
application/json:
schema:
$ref: "#/components/schemas/NewCampaign"
responses:
"200":
description: The created campaign. This contains the token that can
be used to interact with this campaign. This will be provided only
this time, as it will be stored in hashed form afterwards.
content:
application/json:
schema:
$ref: "#/components/schemas/CreatedCampaign"
"401":
$ref: "#/components/responses/UnauthorizedError"
"409":
$ref: "#/components/responses/ConflictError"
"422":
$ref: "#/components/responses/InvalidParameterError"
default:
$ref: "#/components/responses/Error"
/campaigns/{campaign_id}:
get:
summary: Get metadata of a campaign
tags:
- internal
operationId: handlers.campaigns.get_metadata
parameters:
- name: campaign_id
in: path
required: true
description: The id of the campaign
schema:
type: integer
responses:
"200":
description: The metadata of this campaign
content:
application/json:
schema:
$ref: "#/components/schemas/Campaign"
"401":
$ref: "#/components/responses/UnauthorizedError"
"404":
$ref: "#/components/responses/DoesNotExistError"
default:
$ref: "#/components/responses/Error"
put:
summary: Change the status of a campaign
tags:
- internal
operationId: handlers.campaigns.change_status
parameters:
- name: campaign_id
in: path
required: true
description: The id of the campaign
schema:
type: integer
requestBody:
description: The new status to set the campaign to
required: true
content:
application/json:
schema:
type: object
required:
- new_status
properties:
new_status:
$ref: "#/components/schemas/CampaignStatus"
responses:
"200":
description: Successfully changed the campaign status
"401":
$ref: "#/components/responses/UnauthorizedError"
"404":
$ref: "#/components/responses/DoesNotExistError"
"409":
$ref: "#/components/responses/ConflictError"
default:
$ref: "#/components/responses/Error"
/campaigns/{campaign_id}/images:
get:
summary: Get a list of images for a campaign.
tags:
- external
operationId: handlers.campaigns.get_images
parameters:
- name: campaign_id
in: path
required: true
description: The id of the campaign
schema:
type: integer
- name: page
in: query
required: false
description: Page of results to retrieve
schema:
type: integer
minimum: 1
example: 1
- name: per_page
in: query
required: false
description: Number of results to retrieve per page
schema:
type: integer
minimum: 1
example: 10
responses:
"200":
description: A paged array of images in the campaign
content:
application/json:
schema:
$ref: "#/components/schemas/ImagePathList"
"401":
$ref: "#/components/responses/UnauthorizedError"
"404":
$ref: "#/components/responses/DoesNotExistError"
default:
$ref: "#/components/responses/Error"
post:
summary: Add images to a campaign
tags:
- internal
operationId: handlers.campaigns.add_images
parameters:
- name: campaign_id
in: path
required: true
description: The id of the campaign
schema:
type: integer
requestBody:
description: A list of images to add to the campaign. Image can be
provided either as internal ID or by blobstorage filepath.
required: true
content:
application/json:
schema:
type: array
items:
$ref: "#/components/schemas/NewImageToContainer"
responses:
"200":
description: Successfully added images to campaign
"401":
$ref: "#/components/responses/UnauthorizedError"
"404":
$ref: "#/components/responses/DoesNotExistError"
"409":
$ref: "#/components/responses/ConflictError"
default:
$ref: "#/components/responses/Error"
/campaigns/{campaign_id}/objects:
get:
summary: Get a list of all images in a campaign, a download link for the
image and the objects found in that image.
tags:
- internal
operationId: handlers.campaigns.get_objects
parameters:
- name: campaign_id
in: path
required: true
description: The id of the campaign
schema:
type: integer
- name: page
in: query
required: false
description: Page of results to retrieve
schema:
type: integer
minimum: 1
example: 1
- name: per_page
in: query
required: false
description: Number of results to retrieve per page
schema:
type: integer
minimum: 1
example: 10
responses:
"200":
description: A paged array of images and objects in the campaign
content:
application/json:
schema:
$ref: "#/components/schemas/CampaignImageObjectList"
"401":
$ref: "#/components/responses/UnauthorizedError"
"404":
$ref: "#/components/responses/DoesNotExistError"
default:
$ref: "#/components/responses/Error"
put:
summary: Submit found objects for given images in the campaign
tags:
- external
operationId: handlers.campaigns.add_objects
parameters:
- name: campaign_id
in: path
required: true
description: The id of the campaign
schema:
type: integer
requestBody:
description: A list of detected objects to add to the campaign. This
will override any objects already stored for an image.
required: true
content:
application/json:
schema:
$ref: "#/components/schemas/NewImageObjectList"
responses:
"200":
description: Successfully added the labels to the system
"401":
$ref: "#/components/responses/UnauthorizedError"
"404":
$ref: "#/components/responses/DoesNotExistError"
"409":
$ref: "#/components/responses/ConflictError"
default:
$ref: "#/components/responses/Error"
components:
schemas:
# Image & Image set
ImageSetList:
type: object
required:
- pagination
- image_sets
properties:
pagination:
description: Pagination data
type: object
$ref: "#/components/schemas/Paginate"
image_sets:
description: List of image set objects
type: array
items:
$ref: "#/components/schemas/ImageSet"
ImageSet:
type: object
required:
- imageset_id
- title
- status
- metadata
- blobstorage_path
- date_created
- date_finished
- created_by
properties:
imageset_id:
description: ID of the image set
type: integer
minimum: 0
example: 42
title:
description: Name of the image set
type: string
example: DroneFootage
status:
$ref: '#/components/schemas/ImageSetStatus'
metadata:
description: Additional, flexibly structured, metadata.
nullable: true
type: object
blobstorage_path:
description: Location where the data of this image set is stored
type: string
format: path
nullable: true
example: /uploads/20201012-DroneFootage/
date_created:
description: Date and time this image set was created
type: string
format: date-time
example: 2020-10-12T11:42:42Z
date_finished:
description: Date and time this image set was set to finished
type: string
nullable: true
format: date-time
example: 2020-10-12T11:42:42Z
created_by:
description: User (as email) that created this image set
type: string
format: email
NewImageSet:
type: object
required:
- title
properties:
title:
description: Name of the image set
type: string
minLength: 1
maxLength: 128
example: DroneFootage
metadata:
description: Additional, flexibly structured, metadata.
nullable: true
type: object
ImageList:
type: object
required:
- pagination
- images
properties:
pagination:
description: Pagination data
type: object
$ref: "#/components/schemas/Paginate"
images:
description: List of images
type: array
items:
$ref: "#/components/schemas/Image"
CreatedImageSet:
type: object
allOf:
- $ref: "#/components/schemas/ImageSet"
- type: object
required:
- dropbox_url
properties:
dropbox_url:
description: SAS token enabled URL pointing to the dropbox
where images for this set can be uploaded.
type: string
format: url
Image:
type: object
required:
- image_id
- blobstorage_path
- imageset
- date_taken
- location_taken
- type
- metadata
- tss_id
- file
properties:
image_id:
description: ID of the image
type: integer
minimum: 0
example: 42
blobstorage_path:
description: Path to the image in storage
type: string
example: /uploads/20201012-DroneFootage/img00001.jpg
imageset:
description: Imageset this is a part oneOf
type: object
nullable: true
required:
- imageset_id
- title
properties:
imageset_id:
description: ID of the image set
type: integer
minimum: 0
example: 42
title:
description: Name of the image set
type: string
example: DroneFootage
date_taken:
description: The date & time this image was taken
type: string
nullable: true
format: date-time
example: 2020-10-12T11:42:42Z
location_taken:
type: object
required:
- description
- lat
- lon
properties:
description:
description: The location this image was taken
type: string
nullable: true
lat:
description: The location's latitude
type: number
format: float
nullable: true
example: 51.920801
lon:
description: The location's longitude
type: number
format: float
nullable: true
example: 4.4662474
type:
description: The type of this image
type: string
nullable: true
example: Drone
metadata:
description: Additional, flexibly structured, metadata.
nullable: true
type: object
tss_id:
description: If this image is in the Time Series Store, this
identifies its entry in that database
type: string
nullable: true
file:
type: object
required:
- filetype
- filesize
- dimension
properties:
filetype:
description: Type of file
type: string
nullable: true
example: JPEG
filesize:
description: Size of the file on disk, in bytes
type: integer
nullable: true
minimum: 0
example: 123456
dimensions:
type: object
required:
- width
- height
properties:
width:
description: Width of the image in pixels
type: integer
nullable: true
minimum: 0
example: 1920
height:
description: Height of the image in pixels
type: integer
nullable: true
minimum: 0
example: 1080
ImagePathList:
type: object
required:
- pagination
- images
properties:
pagination:
description: Pagination data
type: object
$ref: "#/components/schemas/Paginate"
images:
description: Paginated list of images
type: array
items:
$ref: "#/components/schemas/ImagePath"
ImagePath:
type: object
required:
- image_id
- url
properties:
image_id:
description: ID of the image
type: integer
minimum: 0
example: 42
url:
description: URL where the image can be retrieved. Use this as
<basepath of the API>/<provided url>. For example, if the url
returned here is /images/42, the full path could be
http://localhost:8080/api/v1/images/42
type: string
format: uri
example: /images/42
NewImageToContainer:
description: Provide either the ID or the URL to an image to add to a
an entity.
oneOf:
- type: object
required:
- id
properties:
id:
description: Internal ID of the image
type: integer
minimum: 0
example: 42
- type: object
required:
- filepath
properties:
filepath:
description: Path in storage where the image can be found
type: string
format: path
example: /uploads/20201012-DroneFootage/img00001.jpg
# Labeled objects
Object:
type: object
required:
- object_id
- image_id
- campaign_id
- label
- bounding_box
- confidence
- date_added
properties:
object_id:
description: ID of the object
type: integer
minimum: 0
example: 42
image_id:
description: ID of the image this object is found in
type: integer
minimum: 0
example: 42
campaign_id:
description: ID of the campaign that labeled this object
type: integer
minimum: 0
example: 42
label:
description: The label attached to this object
type: string
example: PET
bounding_box:
$ref: "#/components/schemas/BoundingBox"
confidence:
description: Confidence of this label
type: number
nullable: true
format: float
minimum: 0.0
maximum: 1.0
example: 0.87
date_added:
description: Date and time this label was added to the database
type: string
format: date-time
example: 2020-10-12T11:42:42Z
NewImageObjectList:
type: array
items:
type: object
$ref: "#/components/schemas/NewImageObjects"
NewImageObjects:
type: object
required:
- image_id
- objects
properties:
image_id:
description: ID of the image the objects are found in
type: integer
minimum: 0
example: 42
objects:
type: array
items:
$ref: "#/components/schemas/NewObject"
NewObject:
type: object
required:
- bounding_box
- label
properties:
bounding_box:
$ref: "#/components/schemas/BoundingBox"
label:
description: The name of the detected object.
type: string
minLength: 1
maxLength: 128
example: PET
label_translated:
description: An optional name to set for the object. If this is
provided, this will be used as the main name for the label, the
value set in "label" will be stored as label_original. This can be
used to store a difference between TOC label taxonomy and a
labeling providers' taxonomy.
nullable: true
type: string
example: Plastic
confidence:
description: How certain this labeling is
nullable: true
type: number
format: float
minimum: 0.0
maximum: 1.0
example: 0.87
BoundingBox:
type: object
required:
- xmin
- xmax
- ymin
- ymax
properties:
xmin:
description: Start of the bounding box on the horizontal axis, as
pixel
type: integer
minimum: 0
example: 123
xmax:
description: End of the bounding box on the horizontal axis, as pixel
type: integer
minimum: 0
example: 256
ymin:
description: Start of the bounding box on the vertical axis, as pixel
type: integer
minimum: 0
example: 187
ymax:
description: End of the bounding box on the vertical axis, as pixel
type: integer
minimum: 0
example: 231
# Campaign
CampaignList:
type: object
required:
- pagination
You can’t perform that action at this time.