-
Notifications
You must be signed in to change notification settings - Fork 8
/
api.yaml
1059 lines (955 loc) · 25.1 KB
/
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
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.2'
info:
title: Photofield
version: '0.1'
servers:
- url: http://localhost:8080
paths:
/collections:
get:
description: Get all available collections (sets of files).
tags: ["Source"]
responses:
"200":
description: List of collections
content:
"application/json":
schema:
type: object
properties:
items:
type: array
items:
$ref: "#/components/schemas/Collection"
/collections/{id}:
get:
description: Get a specific collection
tags: ["Source"]
parameters:
- name: id
in: path
required: true
description: Opaque identifier
schema:
$ref: "#/components/schemas/CollectionId"
responses:
"200":
description: OK
content:
"application/json":
schema:
$ref: "#/components/schemas/Collection"
"404":
description: Collection not found
content:
"application/json":
schema:
$ref: "#/components/schemas/Problem"
/scenes:
post:
description: Create a new scene using the provided parameters
tags: ["Display"]
requestBody:
required: true
content:
application/json:
schema:
$ref: "#/components/schemas/SceneParams"
responses:
"202":
description: Accepted, it might take some time for it to fully finish creating.
content:
application/json:
schema:
$ref: "#/components/schemas/Scene"
"400":
description: Bad request parameters
content:
"application/json":
schema:
$ref: "#/components/schemas/Problem"
get:
description: Get existing scenes matching the provided parameters
tags: ["Display"]
parameters:
- name: collection_id
in: query
required: true
description: Collection ID
schema:
$ref: "#/components/schemas/CollectionId"
- name: viewport_width
in: query
schema:
$ref: "#/components/schemas/ViewportWidth"
- name: viewport_height
in: query
schema:
$ref: "#/components/schemas/ViewportHeight"
- name: image_height
in: query
schema:
$ref: "#/components/schemas/ImageHeight"
- name: layout
in: query
schema:
$ref: "#/components/schemas/LayoutType"
- name: sort
in: query
schema:
$ref: "#/components/schemas/Sort"
- name: search
in: query
schema:
$ref: "#/components/schemas/Search"
- name: tweaks
in: query
schema:
$ref: "#/components/schemas/Tweaks"
- name: limit
in: query
schema:
$ref: "#/components/schemas/Limit"
responses:
"200":
description: List of scenes created for the specified collection
content:
"application/json":
schema:
type: object
properties:
items:
type: array
items:
$ref: "#/components/schemas/Scene"
/scenes/{id}:
get:
description: Get a previously created scene
tags: ["Display"]
parameters:
- name: id
in: path
required: true
description: Opaque randomly generated identifier
schema:
$ref: "#/components/schemas/SceneId"
responses:
"200":
description: OK
content:
"application/json":
schema:
$ref: "#/components/schemas/Scene"
"404":
description: Scene not found
content:
"application/json":
schema:
$ref: "#/components/schemas/Problem"
/scenes/{scene_id}/tiles:
get:
description: Get a rendered tile
tags: ["Display"]
parameters:
- name: scene_id
in: path
required: true
schema:
$ref: "#/components/schemas/SceneId"
- name: tile_size
in: query
required: true
schema:
type: integer
minimum: 1
example: 256
- name: color
in: query
schema:
$ref: "#/components/schemas/Color"
- name: background_color
in: query
schema:
$ref: "#/components/schemas/Color"
- name: transparency_mask
in: query
schema:
type: boolean
- name: zoom
in: query
required: true
schema:
type: integer
minimum: 0
example: 3
- name: "x"
in: query
required: true
schema:
$ref: "#/components/schemas/TileCoord"
- name: "y"
in: query
required: true
schema:
$ref: "#/components/schemas/TileCoord"
- name: sources
in: query
schema:
type: array
items:
type: string
style: form
explode: false
- name: select_tag
description: Show images with this tag as selected.
in: query
schema:
type: string
- name: debug_overdraw
in: query
schema:
type: boolean
example: false
- name: debug_thumbnails
in: query
schema:
type: boolean
example: false
- name: quality_preset
in: query
schema:
type: string
example: "HIGH"
responses:
"200":
description: OK
content:
"image/jpeg":
schema:
type: string
format: binary
/scenes/{scene_id}/dates:
get:
description: Get layout photo dates
tags: ["Display"]
parameters:
- name: scene_id
in: path
required: true
schema:
$ref: "#/components/schemas/SceneId"
- name: height
in: query
required: true
schema:
type: integer
minimum: 1
maximum: 10000
example: 1920
responses:
"200":
description: OK
content:
"application/octet-stream":
schema:
type: string
format: binary
description: |
List of `height` uint32-encoded "local" timestamps of photos
in the layout. This is similar to a Unix timestamp, except
that it is offset by the local time zone of the photo.
/scenes/{scene_id}/regions:
get:
description: Get regions within a certain bounding box
tags: ["Display"]
parameters:
- name: scene_id
in: path
required: true
schema:
$ref: "#/components/schemas/SceneId"
- name: file_id
in: query
required: false
schema:
$ref: "#/components/schemas/FileId"
- name: "x"
in: query
required: false
schema:
type: number
example: 10
- name: "y"
in: query
required: false
schema:
type: number
example: 200
- name: w
in: query
required: false
schema:
type: number
example: 300
- name: h
in: query
required: false
schema:
type: number
example: 200
- name: closest
in: query
description: |
If true, return the closest region to the specified `x` and `y` coordinates.
The `w` and `h` parameters are ignored in this case.
schema:
type: boolean
example: false
- name: limit
in: query
schema:
$ref: "#/components/schemas/Limit"
responses:
"200":
description: Region list
content:
"application/json":
schema:
type: object
properties:
items:
type: array
items:
$ref: "#/components/schemas/Region"
/scenes/{scene_id}/regions/{id}:
get:
description: Get a specific region
tags: ["Display"]
parameters:
- name: scene_id
in: path
required: true
schema:
$ref: "#/components/schemas/SceneId"
- name: id
in: path
required: true
description: Region ID
schema:
$ref: "#/components/schemas/RegionId"
responses:
"200":
description: OK
content:
"application/json":
schema:
$ref: "#/components/schemas/Region"
"404":
description: Region not found
content:
"application/json":
schema:
$ref: "#/components/schemas/Problem"
/files/{id}:
get:
description: Get a file (referenced by region data)
tags: ["Files"]
parameters:
- $ref: "#/components/parameters/FileIdPathParam"
responses:
"200":
$ref: "#/components/responses/FileResponse"
"404":
$ref: "#/components/responses/FileNotFound"
/files/{id}/original/{filename}:
get:
description: Get a file via with an arbitrary filename as part of the URL
tags: ["Files"]
parameters:
- $ref: "#/components/parameters/FileIdPathParam"
- $ref: "#/components/parameters/FilenamePathParam"
responses:
"200":
$ref: "#/components/responses/FileResponse"
"404":
$ref: "#/components/responses/FileNotFound"
/files/{id}/variants/{size}/{filename}:
get:
description: Get an image or resized video variant/thumbnail of the
specified predefined size and with an arbitrary filename as part of the URL
tags: ["Files"]
parameters:
- $ref: "#/components/parameters/FileIdPathParam"
- $ref: "#/components/parameters/FilenamePathParam"
- $ref: "#/components/parameters/SizePathParam"
responses:
"200":
$ref: "#/components/responses/FileResponse"
"404":
$ref: "#/components/responses/FileNotFound"
/tags:
get:
description: Retrieve a list of tags
tags: ["Tags"]
parameters:
- $ref: "#/components/parameters/SearchParam"
responses:
"200":
description: List of tags retrieved successfully
content:
application/json:
schema:
type: object
required:
- items
properties:
items:
$ref: "#/components/schemas/Tags"
post:
description: Add tag
tags: ["Tags"]
requestBody:
required: true
content:
application/json:
schema:
$ref: "#/components/schemas/TagsPost"
responses:
"201":
description: Tag created.
content:
application/json:
schema:
$ref: "#/components/schemas/Tag"
/tags/{id}:
get:
description: Get a specific tag
tags: ["Tags"]
parameters:
- $ref: "#/components/parameters/TagIdPathParam"
responses:
"200":
description: Tag retrieved successfully
content:
application/json:
schema:
$ref: "#/components/schemas/Tag"
/tags/{id}/files:
post:
description: Perform an operation on the files for this specific tag.
tags: ["Tags"]
parameters:
- $ref: "#/components/parameters/TagIdPathParam"
requestBody:
required: true
content:
application/json:
schema:
$ref: "#/components/schemas/TagFilesPost"
responses:
"200":
description: Tag operation successfully completed on the files.
/tags/{id}/files-tags:
get:
description: Get all tags of files with the specified tag
tags: ["Tags"]
parameters:
- $ref: "#/components/parameters/TagIdPathParam"
responses:
"200":
description: List of tags
content:
application/json:
schema:
type: object
required:
- items
properties:
items:
$ref: "#/components/schemas/Tags"
files_count:
type: integer
minimum: 0
example: 13
/tasks:
post:
description: Create a new task e.g. scan the file system for files
in directories specified in the provided collection.
tags: ["System"]
requestBody:
required: true
content:
application/json:
schema:
type: object
required:
- type
- collection_id
properties:
type:
$ref: "#/components/schemas/TaskType"
collection_id:
$ref: "#/components/schemas/CollectionId"
responses:
"202":
description: Accepted, it might take some time for the task to finish.
content:
application/json:
schema:
$ref: "#/components/schemas/Task"
"409":
description: Conflict, task already in progress for the
specified parameters.
content:
application/json:
schema:
$ref: "#/components/schemas/Task"
get:
description: Get currently running tasks.
tags: ["System"]
parameters:
- name: type
in: query
description: Task type to filter on.
schema:
$ref: "#/components/schemas/TaskType"
- name: collection_id
in: query
description: Collection ID for the tasks
schema:
$ref: "#/components/schemas/CollectionId"
responses:
"200":
description: List of tasks
content:
"application/json":
schema:
type: object
properties:
items:
type: array
items:
$ref: "#/components/schemas/Task"
/capabilities:
get:
description: Get the current capabilities of the system.
tags: ["System"]
responses:
"200":
description: Capabilities
content:
"application/json":
schema:
$ref: "#/components/schemas/Capabilities"
components:
responses:
FileResponse:
description: Raw binary file (image or video)
content:
"image/*":
schema:
$ref: "#/components/schemas/FileBinary"
FileNotFound:
description: Raw binary file (image or video)
content:
"image/*":
schema:
$ref: "#/components/schemas/FileBinary"
parameters:
SearchParam:
name: q
in: query
description: Search custom text query
schema:
$ref: "#/components/schemas/Search"
TagIdPathParam:
name: id
in: path
required: true
description: Tag ID
schema:
$ref: "#/components/schemas/TagId"
FileIdPathParam:
name: id
in: path
required: true
description: File ID
schema:
$ref: "#/components/schemas/FileId"
FilenamePathParam:
name: filename
in: path
required: true
description: Arbitrary file name, used for better UX when opened
directly in a browser.
schema:
type: string
example: photo.jpg
SizePathParam:
name: size
in: path
required: true
description: Thumbnail size type label
schema:
type: string
example: M
schemas:
Scene:
type: object
required:
- id
properties:
id:
$ref: "#/components/schemas/SceneId"
bounds:
$ref: "#/components/schemas/Bounds"
file_count:
type: integer
minimum: 0
example: 506
load_count:
type: integer
minimum: 0
example: 123
load_unit:
type: string
example: files
default: files
loading:
type: boolean
description: True while the scene is loading and the dimensions are not yet known.
error:
type: string
description: Any error encountered while loading the scene
Collection:
type: object
required:
- id
properties:
id:
$ref: "#/components/schemas/CollectionId"
name:
type: string
description: User-friendly name
example: Vacation Photos
indexed_at:
type: string
format: date-time
description: Time of latest performed full index
IndexTask:
type: object
properties:
collection_id:
$ref: "#/components/schemas/CollectionId"
count:
type: integer
minimum: 0
example: 13
description: Number of files found since the start of the indexing.
Task:
type: object
required:
- id
- name
properties:
id:
$ref: "#/components/schemas/TaskId"
type:
$ref: "#/components/schemas/TaskType"
name:
type: string
collection_id:
$ref: "#/components/schemas/CollectionId"
pending:
type: integer
minimum: 0
example: 13
description: Number of items pending as part of the task.
done:
type: integer
minimum: 0
example:
description: Number of items already processed.
Capabilities:
type: object
required:
- search
- tags
- docs
properties:
search:
$ref: "#/components/schemas/Capability"
tags:
$ref: "#/components/schemas/Capability"
docs:
$ref: "#/components/schemas/DocsCapability"
Capability:
type: object
required:
- supported
properties:
supported:
type: boolean
DocsCapability:
allOf:
- $ref: "#/components/schemas/Capability"
- type: object
required:
- url
properties:
url:
type: string
description: URL to the documentation to link to from the UI.
default: /docs/usage
Region:
type: object
required:
- id
- bounds
properties:
id:
$ref: "#/components/schemas/RegionId"
bounds:
$ref: "#/components/schemas/Bounds"
data:
$ref: "#/components/schemas/RegionData"
RegionData:
type: object
FileBinary:
type: string
format: binary
File:
type: object
properties:
id:
$ref: "#/components/schemas/FileId"
path:
type: string
example: "photos/vacation/IMG_1234.JPG"
filename:
type: string
example: "IMG_1234.JPG"
extension:
type: string
example: ".JPG"
video:
type: boolean
example: false
width:
type: integer
example: 5472
height:
type: integer
example: 3648
created_at:
type: string
format: date-time
example: "2024-04-01T19:12:08-03:59"
thumbnails:
type: array
items:
$ref: "#/components/schemas/Thumbnail"
tags:
type: array
items:
$ref: "#/components/schemas/Tag"
Thumbnail:
type: object
required:
- name
- display_name
- width
- height
- filename
properties:
name:
type: string
display_name:
type: string
width:
type: integer
height:
type: integer
filename:
type: string
SceneParams:
type: object
required:
- collection_id
- viewport_width
- viewport_height
- layout
properties:
collection_id:
$ref: "#/components/schemas/CollectionId"
viewport_width:
$ref: "#/components/schemas/ViewportWidth"
viewport_height:
$ref: "#/components/schemas/ViewportHeight"
tweaks:
$ref: "#/components/schemas/Tweaks"
image_height:
$ref: "#/components/schemas/ImageHeight"
layout:
$ref: "#/components/schemas/LayoutType"
search:
$ref: "#/components/schemas/Search"
sort:
$ref: "#/components/schemas/Sort"
TagsPost:
type: object
description: Create a new tag based on the provided parameters.
properties:
selection:
type: boolean
collection_id:
$ref: "#/components/schemas/CollectionId"
TagFilesPost:
type: object
description: |
Perform the specified tag operation for the specified files.
You need to provide either a `scene_id` & `bounds` or `file_id`.
required:
- op
properties:
op:
$ref: "#/components/schemas/Operation"
scene_id:
$ref: "#/components/schemas/SceneId"
bounds:
$ref: "#/components/schemas/Bounds"
file_id:
$ref: "#/components/schemas/FileId"
tag_id:
$ref: "#/components/schemas/TagId"
Tags:
type: array
items:
$ref: "#/components/schemas/Tag"
Tag:
type: object
properties:
id:
type: string
name:
type: string
updated_at:
type: string
format: date-time
etag:
type: string
description: ETag for optimistic concurrency control
TaskType:
type: string
enum:
- INDEX_FILES
- INDEX_METADATA
- INDEX_CONTENTS
- INDEX_CONTENTS_COLOR
- INDEX_CONTENTS_AI
CollectionId:
type: string
example: vacation-photos
TaskId:
type: string
example: index-vacation-photos
Operation:
type: string
enum:
- ADD
- SUBTRACT
- INVERT
SceneId:
type: string
example: Tqcqtc6h69
Color:
type: string
example: "#ff0000"
ViewportWidth:
type: number
minimum: 0
example: 1200
ViewportHeight:
type: number
minimum: 0
example: 800
Tweaks:
type: string
ImageWidth:
type: number
minimum: 0
example: 400
ImageHeight:
type: number
minimum: 0
example: 300
RegionId:
type: integer
example: 0
FileId:
type: integer
example: 0
TagId:
type: string
example: fav
TileCoord:
type: integer
minimum: 0
example: 0
Sources:
type: array
Bounds: