-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathopenapi.yml
1098 lines (1088 loc) · 32.9 KB
/
openapi.yml
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.3
info:
title: File API
version: 0.2.0
description: Upload and manage epilot Files
tags:
- name: File
description: Upload and Manage File Entities
- name: Preview
description: Preview APIs
- name: Public Links
description: Create and Manage Public Links for Files
- name: Session
description: Session API for cookie authentication
- name: Deprecated
description: Deprecated APIs
security:
- EpilotAuth: []
- CookieAuth: []
paths:
/v2/files/upload:
post:
operationId: uploadFileV2
summary: uploadFileV2
description: |
Create pre-signed S3 URL to upload a file to keep temporarily (one week).
Use the saveFileV2 operation to store file file permanently.
tags:
- File
parameters:
- name: file_entity_id
in: query
description: |
Use this parameter when uploading a file directly to an existing file entity.
Note: still requires calling saveFileV2 to save the file permanently.
schema:
$ref: '#/components/schemas/FileEntityId'
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/UploadFilePayload'
examples:
Upload an image file:
description: Upload an image file
value:
filename: image.png
mime_type: image/png
Upload a document:
description: Upload an image file
value:
filename: document.pdf
mime_type: application/pdf
responses:
'201':
description: Pre-signed URL for POST / PUT upload
content:
application/json:
schema:
$ref: '#/components/schemas/FileUpload'
/v2/files:
post:
operationId: saveFileV2
summary: saveFileV2
description: |
Saves a permanent file entity. Updates an existing file entity when `_id` is passed.
Saves metadata to file entity and stores a version when `s3ref` or `source_url` is passed.
tags:
- File
parameters:
- $ref: '#/components/parameters/ActivityIdQueryParam'
- $ref: '#/components/parameters/FillActivityQueryParam'
- $ref: '#/components/parameters/StrictQueryParam'
- $ref: '#/components/parameters/AsyncOperationQueryParam'
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/SaveFilePayloadV2'
examples:
New file from s3ref:
description: Standard epilot file entity with S3 Ref
value:
type: document
filename: document.pdf
_tags:
- string
access_control: private
s3ref:
bucket: epilot-prod-user-content
key: 123/4d689aeb-1497-4410-a9fe-b36ca9ac4389/document.pdf
Update existing file with relations:
description: Update existing file entity with _id
value:
_id: ef7d985c-2385-44f4-9c71-ae06a52264f8
filename: document.pdf
access_control: private
custom_download_url: https://some-api-url.com/download?file_id=123
shared_with_end_customer: true
relations:
- entity_id: 77a1e0cc-7b92-4d41-8cce-eefd317ec004
_schema: contact
New file from source_url:
description: New epilot file entity from a source_url
value:
type: document
filename: document.pdf
_tags:
- string
access_control: private
source_url: https://docs.epilot.io/document.pdf
File with custom download URL (external):
description: Custom file entity with custom download url
value:
type: document
filename: document.pdf
_tags:
- string
access_control: private
custom_download_url: https://some-api-url.com/download?file_id=123
shared_with_end_customer: true
responses:
'200':
description: Created File Entity
content:
application/json:
schema:
$ref: '#/components/schemas/FileEntity'
/v1/files/upload:
post:
operationId: uploadFile
summary: uploadFile
deprecated: true
description: |
Create pre-signed S3 URL to upload a file to keep temporarily (one week).
Use the saveFile operation to store file file permanently.
tags:
- Deprecated
parameters:
- name: file_entity_id
in: query
description: file entity id
schema:
$ref: '#/components/schemas/FileEntityId'
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/UploadFilePayload'
responses:
'201':
description: Pre-signed URL for POST / PUT upload
content:
application/json:
schema:
type: object
properties:
s3ref:
allOf:
- $ref: '#/components/schemas/S3Ref'
- example:
bucket: epilot-prod-user-content
key: 123/temp/4d689aeb-1497-4410-a9fe-b36ca9ac4389/document.pdf
upload_url:
type: string
format: url
example: https://epilot-prod-user-content.s3.eu-central-1.amazonaws.com/123/temp/4d689aeb-1497-4410-a9fe-b36ca9ac4389/document.pdf?AWSParams=123
public_url:
description: Returned only if file is permanent i.e. file_entity_id is passed
type: string
format: url
example: https://epilot-prod-user-content.s3.eu-central-1.amazonaws.com/123/4d689aeb-1497-4410-a9fe-b36ca9ac4389/document.pdf
/v1/files:
post:
operationId: saveFile
summary: saveFile
deprecated: true
description: |
Create / Update a permanent File entity
Makes file object permanent
Saves metadata to file entity
tags:
- Deprecated
parameters:
- $ref: '#/components/parameters/ActivityIdQueryParam'
- $ref: '#/components/parameters/AsyncOperationQueryParam'
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/SaveFilePayload'
responses:
'201':
description: Created File Entity
content:
application/json:
schema:
$ref: '#/components/schemas/FileEntity'
/v2/files/{id}:
get:
operationId: getFile
summary: getFile
description: Get a file entity by id
tags:
- File
parameters:
- name: id
in: path
required: true
schema:
$ref: '#/components/schemas/FileEntityId'
- name: source_url
in: query
schema:
type: boolean
default: false
description: Generate a source_url for the file entity, if it doesn't have one
- $ref: '#/components/parameters/StrictQueryParam'
- $ref: '#/components/parameters/AsyncOperationQueryParam'
responses:
'200':
description: File Entity
content:
application/json:
schema:
$ref: '#/components/schemas/FileEntity'
delete:
operationId: deleteFile
summary: deleteFile
description: Delete a file entity by id
tags:
- File
parameters:
- name: id
in: path
required: true
schema:
$ref: '#/components/schemas/FileEntityId'
- $ref: '#/components/parameters/ActivityIdQueryParam'
- $ref: '#/components/parameters/StrictQueryParam'
responses:
'200':
description: The deleted file
content:
application/json:
schema:
$ref: '#/components/schemas/FileEntity'
/v1/files/{id}/download:
get:
operationId: downloadFile
summary: downloadFile
description: Generate pre-signed download S3 url for a file
tags:
- File
parameters:
- name: id
in: path
required: true
schema:
$ref: '#/components/schemas/FileEntityId'
- name: version
in: query
description: index of file version
schema:
type: integer
default: 0
- name: attachment
in: query
description: Controls the Content-Disposition header to control browser behaviour. Set to true to trigger download.
schema:
type: boolean
default: true
responses:
'200':
description: Generated thumbnail image
content:
application/json:
schema:
type: object
properties:
download_url:
type: string
format: uri
example: https://epilot-prod-user-content.s3.eu-central-1.amazonaws.com/123/temp/4d689aeb-1497-4410-a9fe-b36ca9ac4389/document.pdf?AWSParams=123
/v1/files:downloadS3:
post:
operationId: downloadS3File
summary: downloadS3File
description: Generate pre-signed download S3 url for a file
tags:
- File
parameters:
- name: s3_key
in: query
required: true
schema:
type: string
- name: s3_bucket
in: query
required: true
schema:
type: string
- name: attachment
in: query
description: Controls the Content-Disposition header to control browser behaviour. Set to true to trigger download.
schema:
type: boolean
default: true
responses:
'200':
description: Generated thumbnail image
content:
application/json:
schema:
type: object
properties:
download_url:
type: string
format: uri
example: https://epilot-prod-user-content.s3.eu-central-1.amazonaws.com/123/temp/4d689aeb-1497-4410-a9fe-b36ca9ac4389/document.pdf?AWSParams=123
/v1/files:downloadFiles:
post:
operationId: downloadFiles
summary: downloadFiles
description: Bulk generate pre-signed download S3 urls for multiple files
tags:
- File
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/DownloadFilesPayload'
responses:
'200':
description: Generated download urls
content:
application/json:
schema:
type: array
items:
type: object
properties:
download_url:
type: string
format: uri
example: https://epilot-prod-user-content.s3.eu-central-1.amazonaws.com/123/temp/4d689aeb-1497-4410-a9fe-b36ca9ac4389/document.pdf?AWSParams=123
file_entity_id:
type: string
format: uuid
/v1/files/{id}/preview:
get:
operationId: previewFile
summary: previewFile
description: Generate thumbnail preview for a file entity
tags:
- Preview
parameters:
- name: id
in: path
required: true
schema:
$ref: '#/components/schemas/FileEntityId'
- name: version
in: query
description: index of file version
schema:
type: integer
default: 0
- name: w
in: query
description: width
schema:
type: integer
- name: h
in: query
description: height
schema:
type: integer
responses:
'200':
description: Generated thumbnail image
content:
image/png: {}
image/jpeg: {}
/v1/files:previewS3:
post:
operationId: previewS3File
summary: previewS3File
description: Generate thumbnail preview from an s3 reference for a file entity
tags:
- Preview
parameters:
- name: w
in: query
description: width
schema:
type: integer
- name: h
in: query
description: height
schema:
type: integer
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/S3Ref'
responses:
'200':
description: Generated thumbnail image
content:
image/png: {}
image/jpeg: {}
get:
operationId: previewS3FileGet
summary: previewS3FileGet
description: Get thumbnail preview from an s3 reference for a file entity
tags:
- Preview
parameters:
- name: key
in: query
description: s3 key
required: true
schema:
type: string
- name: bucket
in: query
description: s3 bucket
required: true
schema:
type: string
- name: w
in: query
description: width
schema:
type: integer
- name: h
in: query
description: height
schema:
type: integer
responses:
'200':
description: Generated thumbnail image
content:
image/png: {}
image/jpeg: {}
/v1/files/public/{id}/preview:
get:
operationId: previewPublicFile
summary: previewPublicFile
description: Generate thumbnail preview for a public file entity
security: []
tags:
- Preview
parameters:
- name: id
in: path
required: true
schema:
$ref: '#/components/schemas/FileEntityId'
- name: version
in: query
description: index of file version
schema:
type: integer
default: 0
- name: w
in: query
description: width
schema:
type: integer
- name: h
in: query
description: height
schema:
type: integer
- name: org_id
in: query
description: Org id
schema:
type: string
responses:
'200':
description: Generated thumbnail image for a public file
content:
image/png: {}
image/jpeg: {}
/v1/files/session:
get:
operationId: getSession
summary: getSession
description: |
Start a browser session by setting passed Authorization token in a server side cookie.
Allows using preview urls directly in img src for private files using cookie authentication.
tags:
- Session
responses:
'200':
description: Session started successfully
delete:
operationId: deleteSession
summary: deleteSession
description: End browser session by deleting token cookie
tags:
- Session
responses:
'200':
description: Session deleted successfully
/v1/files/{id}/public/links:
post:
operationId: generatePublicLink
summary: generatePublicLink
description: |
Generates a public link to access a private file
tags:
- Public Links
parameters:
- name: id
in: path
required: true
schema:
$ref: '#/components/schemas/FileEntityId'
responses:
'201':
description: Returns the public link which can be used to access the file later
content:
application/json:
schema:
type: string
example: https://file.sls.epilot.io/v1/files/public/links/3ef5c6d9-818d-45e6-8efb-b1de59079a1c/invoice-2023-12.pdf
get:
operationId: listPublicLinksForFile
summary: listPublicLinksForFile
description: Not yet implemented; This API would fetch all the public links that are previously generated for a file
x-not-implemented: true
parameters:
- name: id
in: path
required: true
schema:
type: string
description: ID of the file entity
example: 13d22918-36bd-4227-9ad4-2cb978788c8d
tags:
- Public Links
responses:
'200':
description: Public links of a file retrieved successfully
content:
application/json:
schema:
type: object
properties:
results:
type: array
items:
$ref: '#/components/schemas/PublicLink'
/v1/files/public/links/{id}/{filename}:
get:
operationId: accessPublicLink
summary: accessPublicLink
security: []
tags:
- Public Links
description: Redirects to a accessible signed url for the respective file associated to the public link
parameters:
- name: id
in: path
required: true
schema:
type: string
description: Id of the publicly generated link
example: 13d22918-36bd-4227-9ad4-2cb978788c8d
- name: filename
in: path
required: true
schema:
type: string
description: Name of the file
example: invoice-2023-12.pdf
responses:
'302':
description: Redirect to signed URL where the caller can access the file
/v1/files/public/links/{id}:
delete:
operationId: revokePublicLink
summary: revokePublicLink
description: Not yet implemented; This operation would revoke a given public link by ID
x-not-implemented: true
parameters:
- name: id
in: path
required: true
schema:
type: string
description: Id of the publicly generated link
example: 13d22918-36bd-4227-9ad4-2cb978788c8d
tags:
- Public Links
responses:
'204':
description: Revokes a public link successfully.
content:
application/json:
schema:
type: string
example: https://file.sls.epilot.io/v1/files/public/links/3ef5c6d9-818d-45e6-8efb-b1de59079a1c
/v1/files/download:verify:
post:
operationId: verifyCustomDownloadUrl
summary: verifyCustomDownloadUrl
description: Verify a pre-signed custom download url for a file
tags:
- File
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/VerifyCustomDownloadUrlPayload'
responses:
'200':
description: Download Url matches signature and has not expired
content:
application/json:
schema:
type: object
properties:
valid:
type: boolean
/v1/files/public/upload:
post:
operationId: uploadFilePublic
summary: uploadFilePublic
security: []
description: |
Create pre-signed S3 URL to upload a file to keep temporarily (one week).
Use the saveFileV2 operation to store file file permanently.
tags:
- File
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/UploadFilePayload'
examples:
Upload an image file:
description: Upload an image file
value:
filename: image.png
mime_type: image/png
Upload a document:
description: Upload an image file
value:
filename: document.pdf
mime_type: application/pdf
responses:
'201':
description: Pre-signed URL for POST / PUT upload
content:
application/json:
schema:
type: object
properties:
s3ref:
allOf:
- $ref: '#/components/schemas/S3Ref'
- example:
bucket: epilot-prod-user-content
key: 123/temp/4d689aeb-1497-4410-a9fe-b36ca9ac4389/document.pdf
upload_url:
type: string
format: url
example: https://epilot-prod-user-content.s3.eu-central-1.amazonaws.com/123/temp/4d689aeb-1497-4410-a9fe-b36ca9ac4389/document.pdf?AWSParams=123
components:
securitySchemes:
EpilotAuth:
type: http
scheme: bearer
description: Authorization header with epilot OAuth2 bearer token
bearerFormat: JWT
CookieAuth:
type: apiKey
in: cookie
name: token
description: Cookie with epilot OAuth2 token
schemas:
EntityId:
type: string
example: ef7d985c-2385-44f4-9c71-ae06a52264f8
EntitySlug:
description: URL-friendly identifier for the entity schema
type: string
example: contact
ActivityId:
type: string
format: ulid
description: See https://github.com/ulid/spec
example: 01F130Q52Q6MWSNS8N2AVXV4JN
FileEntityId:
type: string
example: ef7d985c-2385-44f4-9c71-ae06a52264f8
FileAttributes:
type: object
properties:
_tags:
type: array
items:
type: string
example:
- tag1
- tag2
_purpose:
type: array
items:
type: string
example:
- 8d396871-95a0-4c9d-bb4d-9eda9c35776c
- da7cdf9a-01be-40c9-a29c-9a8f9f0de6f8
_manifest:
type: array
description: Manifest ID used to create/update the entity
items:
type: string
format: uuid
example: 123e4567-e89b-12d3-a456-426614174000
filename:
type: string
example: document.pdf
type:
$ref: '#/components/schemas/FileType'
mime_type:
type: string
description: MIME type of the file
example: application/pdf
size_bytes:
type: integer
minimum: 0
description: File size in bytes
example: 1234
readOnly: true
readable_size:
type: string
example: 1.2 MB
description: Human readable file size
readOnly: true
access_control:
type: string
default: private
enum:
- private
- public-read
public_url:
description: Direct URL for file (public only if file access control is public-read)
type: string
format: url
example: https://epilot-prod-user-content.s3.eu-central-1.amazonaws.com/123/4d689aeb-1497-4410-a9fe-b36ca9ac4389/document.pdf
readOnly: true
custom_download_url:
$ref: '#/components/schemas/CustomDownloadUrl'
FileType:
type: string
enum:
- document
- document_template
- text
- image
- video
- audio
- spreadsheet
- presentation
- font
- archive
- application
- unknown
CustomDownloadUrl:
description: Custom external download url used for the file
type: string
format: uri
example: https://some-api-url.com/download?file_id=123
FileEntity:
allOf:
- type: object
properties:
_title:
type: string
example: document.pdf
_schema:
type: string
enum:
- file
readOnly: true
_org:
type: string
example: '123'
readOnly: true
_id:
$ref: '#/components/schemas/FileEntityId'
- $ref: '#/components/schemas/FileAttributes'
- type: object
properties:
source_url:
type: string
description: Source URL for the file. Included if the entity was created from source_url, or when ?source_url=true
example: https://productengineer-content.s3.eu-west-1.amazonaws.com/product-engineer-checklist.pdf
s3ref:
$ref: '#/components/schemas/S3Ref'
readOnly: true
versions:
type: array
items:
$ref: '#/components/schemas/FileItem'
readOnly: true
_updated_at:
type: string
format: date-time
readOnly: true
_created_at:
type: string
format: date-time
readOnly: true
_acl:
$ref: '#/components/schemas/BaseEntityAcl'
_owners:
type: array
readOnly: true
items:
$ref: '#/components/schemas/BaseEntityOwner'
__additional:
type: object
description: Additional fields that are not part of the schema
additionalProperties: true
nullable: true
required:
- _title
- _schema
- _org
- _id
- filename
- type
- access_control
- versions
CommonSaveFilePayload:
type: object
properties:
_id:
allOf:
- $ref: '#/components/schemas/FileEntityId'
- description: if passed, adds a new version to existing file entity
file_entity_id:
type: string
description: Deprecated, use _id instead
deprecated: true
relations:
type: array
description: List of entities to relate the file to
items:
$ref: '#/components/schemas/FileRelationItem'
additionalProperties: true
SaveS3FilePayload:
allOf:
- $ref: '#/components/schemas/CommonSaveFilePayload'
- $ref: '#/components/schemas/FileAttributes'
- type: object
properties:
s3ref:
$ref: '#/components/schemas/S3Ref'
SaveFileFromSourceURLPayload:
allOf:
- $ref: '#/components/schemas/CommonSaveFilePayload'
- $ref: '#/components/schemas/FileAttributes'
- type: object
properties:
source_url:
$ref: '#/components/schemas/CustomDownloadUrl'
SaveCustomFilePayload:
allOf:
- $ref: '#/components/schemas/CommonSaveFilePayload'
- $ref: '#/components/schemas/FileAttributes'
- type: object
properties:
custom_download_url:
$ref: '#/components/schemas/CustomDownloadUrl'
SaveFilePayload:
anyOf:
- $ref: '#/components/schemas/SaveS3FilePayload'
- $ref: '#/components/schemas/SaveFileFromSourceURLPayload'
- $ref: '#/components/schemas/SaveCustomFilePayload'
SaveFilePayloadV2:
anyOf:
- $ref: '#/components/schemas/SaveS3FilePayload'
- $ref: '#/components/schemas/SaveFileFromSourceURLPayload'
- $ref: '#/components/schemas/SaveCustomFilePayload'
UploadFilePayload:
type: object
properties:
filename:
type: string
example: document.pdf
mime_type:
description: MIME type of file
type: string
example: application/pdf
default: application/octet-stream
index_tag:
type: string
example: 2f6a377c8e78
maxLength: 64
description: Used to index the file at the storage layer, which helps when browsing for this file
metadata:
type: object
additionalProperties:
anyOf:
- type: string
example:
color: blue
description: Allows passing in custom metadata for the file, expects key-value pairs of string type
required:
- filename
FileUpload:
type: object
properties:
s3ref:
allOf:
- $ref: '#/components/schemas/S3Ref'
- example:
bucket: epilot-prod-user-content
key: 123/temp/4d689aeb-1497-4410-a9fe-b36ca9ac4389/document.pdf
upload_url:
type: string
format: url
example: https://epilot-prod-user-content.s3.eu-central-1.amazonaws.com/123/temp/4d689aeb-1497-4410-a9fe-b36ca9ac4389/document.pdf?AWSParams=123
public_url:
description: Returned only if file is permanent i.e. file_entity_id is passed
type: string
format: url
example: https://epilot-prod-user-content.s3.eu-central-1.amazonaws.com/123/4d689aeb-1497-4410-a9fe-b36ca9ac4389/document.pdf
DownloadFilesPayload:
type: array
items:
type: object
properties:
id:
$ref: '#/components/schemas/FileEntityId'
version:
type: integer
description: File version
example: 0
required:
- id
VerifyCustomDownloadUrlPayload:
type: object
properties:
custom_download_url:
description: Custom external download url with signature and expiration time
type: string
format: uri
example: https://some-api-url.com?file_id=123&expires_at=1699273500029&signature=abcdefg
required:
- custom_download_url
S3Reference:
type: object
properties:
bucket:
type: string
example: epilot-prod-user-content
key:
type: string
example: 123/4d689aeb-1497-4410-a9fe-b36ca9ac4389/document.pdf
required:
- bucket
- key
S3Ref:
$ref: '#/components/schemas/S3Reference'
FileItem:
type: object
properties:
s3ref:
$ref: '#/components/schemas/S3Ref'
filename:
type: string
example: document.pdf
size_bytes:
type: integer
example: 1234
readable_size:
type: string
example: 1.2 MB
mime_type:
type: string
example: image/jpeg