-
Notifications
You must be signed in to change notification settings - Fork 0
/
openapi-spec.yaml
822 lines (801 loc) · 25.6 KB
/
openapi-spec.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
openapi: 3.0.3
info:
title: Tempsy RESTful API
description: Temporary Files Storage API Documentation
version: 0.8.0
license:
name: MIT
url: https://opensource.org/license/mit
contact:
name: Afifurrohman
url: https://www.afifurrohman.my.id
email: [email protected]
servers:
- url: https://tempsy.afifurrohman.my.id
description: Production server
- url: https://staging.tempsy.afifurrohman.my.id
description: Staging server
paths:
/files/{username}:
get:
security:
- bearerAuth: [ ]
tags:
- files
summary: Get all files
description: Get all files of the user
parameters:
- $ref: '#/components/parameters/accept'
- $ref: '#/components/parameters/username'
- name: mime_type
in: query
description: Filter by file mime type, using like equalization not strict equalization
required: false
schema:
type: string
- name: name
in: query
description: Filter by name, using like equalization not strict equalization
required: false
schema:
type: string
- name: size
in: query
required: false
description: Filter by file size
schema:
type: integer
format: int64
- name: limit
required: false
in: query
description: Limit List file
schema:
type: integer
format: int64
responses:
200:
description: Success
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/fileData'
examples:
ok:
value:
- name: hello.txt
url: https://storage.googleapis.com/...
autoDeleteAt: 1634179200000
privateUrlExpires: 100
isPublic: false
uploadedAt: 1634179200000
updatedAt: 1634179200000
size: 100
mimeType: text/plain; charset=utf-8
- name: example.png
url: https://tempsy.afifurrohman.my.id/files/afif/public/example.png
autoDeleteAt: 1634179200000
privateUrlExpires: 100
isPublic: true
uploadedAt: 1634179200000
updatedAt: 1634179200000
size: 100
mimeType: image/png
500:
description: Unknown Internal Server Error
content:
application/json:
schema:
$ref: '#/components/schemas/errorResponse'
examples:
error:
$ref: '#/components/examples/internalServer'
post:
security:
- bearerAuth: [ ]
tags:
- files
summary: Upload file
description: Upload file on the server by the user
parameters:
- $ref: '#/components/parameters/accept'
- name: file-name
in: header
description: File name of the file want to be uploaded
required: true
schema:
$ref: '#/components/schemas/fileName'
- $ref: '#/components/parameters/username'
- $ref: '#/components/parameters/fileMetaAutoDeleteAt'
- $ref: '#/components/parameters/fileMetaPrivateUrl'
- $ref: '#/components/parameters/fileMetaPublic'
- $ref: '#/components/parameters/type'
requestBody:
$ref: '#/components/requestBodies/uploadFile'
responses:
201:
description: Success Created
content:
application/json:
schema:
$ref: '#/components/schemas/fileData'
examples:
ok:
$ref: '#/components/examples/dataResponse'
400:
description: Bad Request
content:
application/json:
schema:
$ref: '#/components/schemas/errorResponse'
examples:
invalidFileName:
summary: Bad Request invalid file name
value:
apiError:
kind: invalid_file_name
description: File name must be alphanumeric and contain extension separated by dot, underscore, or dash
errorEmptyFileUpload:
$ref: '#/components/examples/invalidEmptyFile'
422:
description: Unprocessable Entity, Missing Header file metadata
content:
application/json:
schema:
$ref: '#/components/schemas/errorResponse'
examples:
error:
$ref: '#/components/examples/missingHeaderMetadata'
415:
description: Unsupported Media Type
content:
application/json:
schema:
$ref: '#/components/schemas/errorResponse'
examples:
error:
summary: Unsupported Media Type
value:
apiError:
kind: unsupported_content_type
description: 'Unsupported Content-Type: application/octet-stream'
409:
description: Conflict
content:
application/json:
schema:
$ref: '#/components/schemas/errorResponse'
examples:
error:
summary: File name Conflict
value:
apiError:
kind: file_already_exists
description: 'File: hello.txt already exists'
500:
description: Unknown Internal Server Error
content:
application/json:
schema:
$ref: '#/components/schemas/errorResponse'
examples:
error:
$ref: '#/components/examples/internalServer'
delete:
security:
- bearerAuth: []
tags:
- files
summary: Delete all files
description: Delete all files of the user
parameters:
- $ref: '#/components/parameters/accept'
- $ref: '#/components/parameters/username'
responses:
204:
description: Success
400:
description: Bad Request
content:
application/json:
schema:
$ref: '#/components/schemas/errorResponse'
examples:
error:
summary: Bad Request delete empty files
value:
apiError:
kind: delete_empty_data
description: 'Cannot delete empty data files, no data for user: afif'
500:
description: Unknown Internal Server Error
content:
application/json:
schema:
$ref: '#/components/schemas/errorResponse'
examples:
error:
$ref: '#/components/examples/internalServer'
/files/{username}/public/{filename}:
get:
tags:
- file
summary: Get public file
description: Get public file by file name
parameters:
- $ref: '#/components/parameters/accept'
- $ref: '#/components/parameters/username'
- $ref: '#/components/parameters/filename'
responses:
200:
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/fileData'
examples:
ok:
$ref: '#/components/examples/dataResponse'
404:
description: File Not Found
content:
application/json:
schema:
$ref: '#/components/schemas/errorResponse'
examples:
error:
$ref: '#/components/examples/fileNotFound'
500:
description: Unknown Internal Server Error
content:
application/json:
schema:
$ref: '#/components/schemas/errorResponse'
examples:
error:
$ref: '#/components/examples/internalServer'
/files/{username}/{filename}:
get:
security:
- bearerAuth: []
tags:
- file
summary: Get file
description: Get file by file name
parameters:
- $ref: '#/components/parameters/accept'
- $ref: '#/components/parameters/username'
- $ref: '#/components/parameters/filename'
responses:
200:
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/fileData'
examples:
ok:
$ref: '#/components/examples/dataResponse'
404:
description: File Not Found
content:
application/json:
schema:
$ref: '#/components/schemas/errorResponse'
examples:
error:
$ref: '#/components/examples/fileNotFound'
500:
description: Unknown Internal Server Error
content:
application/json:
schema:
$ref: '#/components/schemas/errorResponse'
examples:
error:
$ref: '#/components/examples/internalServer'
put:
security:
- bearerAuth: []
tags:
- file
summary: Update file
description: Update file by file name
parameters:
- $ref: '#/components/parameters/accept'
- $ref: '#/components/parameters/username'
- $ref: '#/components/parameters/filename'
- $ref: '#/components/parameters/fileMetaAutoDeleteAt'
- $ref: '#/components/parameters/fileMetaPrivateUrl'
- $ref: '#/components/parameters/fileMetaPublic'
- $ref: '#/components/parameters/type'
requestBody:
$ref: '#/components/requestBodies/uploadFile'
responses:
200:
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/fileData'
examples:
ok:
$ref: '#/components/examples/dataResponse'
400:
description: Bad Request
content:
application/json:
schema:
$ref: '#/components/schemas/errorResponse'
examples:
errorMismatchContentType:
summary: Bad Request mismatch content type
value:
apiError:
kind: mismatch_content_type
description: Please use the same content type as the original file
errorUpdateWithEmptyFile:
$ref: '#/components/examples/invalidEmptyFile'
422:
description: Unprocessable Entity, Missing Header file metadata
content:
application/json:
schema:
$ref: '#/components/schemas/errorResponse'
examples:
error:
$ref: '#/components/examples/missingHeaderMetadata'
404:
description: File Not Found
content:
application/json:
schema:
$ref: '#/components/schemas/errorResponse'
examples:
error:
$ref: '#/components/examples/fileNotFound'
500:
description: Unknown Internal Server Error
content:
application/json:
schema:
$ref: '#/components/schemas/errorResponse'
examples:
error:
$ref: '#/components/examples/internalServer'
delete:
security:
- bearerAuth: []
tags:
- file
summary: Delete file
description: Delete file by file name
parameters:
- $ref: '#/components/parameters/accept'
- $ref: '#/components/parameters/username'
- $ref: '#/components/parameters/filename'
responses:
204:
description: Success
404:
description: File Not Found
content:
application/json:
schema:
$ref: '#/components/schemas/errorResponse'
examples:
error:
$ref: '#/components/examples/fileNotFound'
500:
description: Unknown Internal Server Error
content:
application/json:
schema:
$ref: '#/components/schemas/errorResponse'
examples:
error:
$ref: '#/components/examples/internalServer'
/auth/userinfo/me:
get:
security:
- bearerAuth: []
tags:
- auth
summary: Get user info
description: Return total files and username
parameters:
- $ref: '#/components/parameters/accept'
responses:
200:
description: Success
content:
application/json:
schema:
type: object
description: api data userinfo
properties:
username:
type: string
description: Username of the user
example: afif
totalFiles:
type: string
description: Email of the user
example: 100
examples:
ok:
value:
username: afif
totalFiles: 100
400:
description: Bad Request
content:
application/json:
schema:
$ref: '#/components/schemas/errorResponse'
examples:
error:
summary: Bad Request invalid token
description: Invalid Token cause by authorization header have invalid token, maybe expires or have been revoked
value:
apiError:
kind: invalid_token
description: Invalid Token, cannot get user info
500:
description: Unknown Internal Server Error
content:
application/json:
schema:
$ref: '#/components/schemas/errorResponse'
examples:
error:
$ref: '#/components/examples/internalServer'
/auth/guest/token:
get:
tags:
- auth
summary: Get guest token
description: return guest token
parameters:
- $ref: '#/components/parameters/accept'
responses:
200:
description: Success
content:
application/json:
schema:
type: object
description: api data guest token
properties:
accessToken:
type: string
description: Guest token
expiresIn:
type: integer
description: Token expires in seconds
example: 3600
400:
description: Bad Request
content:
application/json:
schema:
$ref: '#/components/schemas/errorResponse'
examples:
error:
summary: Bad Request already have token
description: Already have a token
value:
apiError:
kind: already_have_token
description: You already have token
500:
description: Unknown Internal Server Error
content:
application/json:
schema:
$ref: '#/components/schemas/errorResponse'
examples:
error:
$ref: '#/components/examples/internalServer'
components:
securitySchemes:
bearerAuth:
type: http
scheme: bearer
bearerFormat: JWT
description: Google OAuth2 access_token or Guest JWT access_token
parameters:
fileMetaPublic:
name: file-is-public
in: header
description: File is public or not
required: true
schema:
type: boolean
fileMetaPrivateUrl:
name: file-private-url-expires
required: true
in: header
description: Private url will be expires
schema:
description: Seconds, relative from now, Must be positive integer
type: integer
maximum: 604800 # 7 days
minimum: 2
format: int
fileMetaAutoDeleteAt:
name: file-auto-delete-at
in: header
description: File will be delete at, max is one year since now
required: true
schema:
type: integer
format: int64
description: Unix date in milliseconds
username:
name: username
in: path
description: Username of the user
required: true
schema:
type: string
filename:
name: filename
in: path
description: File name of the file
required: true
schema:
type: string
format: name.ext
accept:
name: accept
required: true
in: header
description: Accept Content-Type must be application/json if you want this response api
schema:
type: string
description: Accepted Content-Type by client
enum:
- application/json
- application/json; charset=utf-8
type:
name: content-type
required: true
in: header
description: Content-Type Header for file upload
schema:
type: string
description: Content-Type accepted by the server
enum:
- application/json; charset=utf-8
- application/json
- text/html; charset=utf-8
- text/html
- text/plain; charset=utf-8
- text/plain
- text/javascript; charset=utf-8
- text/javascript
- application/xml; charset=utf-8
- application/xml
- text/csv
- text/css
- image/gif
- image/jpeg
- image/png
- application/x-sh
- image/svg+xml
- image/webp
- image/x-icon # Major Browsers
- image/vnd.microsoft.icon # Standard IANA
- image/avif
- application/wasm
schemas:
fileName:
description: File name pattern of the file
type: string
pattern: ^[a-zA-Z0-9_-]+\.+[a-zA-Z0-9_-]+$
example: example.txt
errorResponse:
description: Error Response body, without data
type: object
properties:
apiError:
type: object
properties:
kind:
type: string
description: Error type
example: invalid_file_name
description:
type: string
description: Error description
example: File name must be alphanumeric and contain extension separated by dot, underscore, or dash
fileData:
description: File Data Response
type: object
properties:
name:
$ref: '#/components/schemas/fileName'
url:
type: string
format: uri
example: https://tempsy.afifurrohman.my.id/files/afif/public/hello.txt
autoDeleteAt:
type: integer
format: int64
description: Unix date in milliseconds
privateUrlExpires:
type: integer
format: int
description: Seconds, relative from now
isPublic:
type: boolean
description: File is public or not
uploadedAt:
type: integer
format: int64
description: Unix date in milliseconds
updatedAt:
type: integer
format: int64
description: Unix date in milliseconds
size:
type: integer
format: int64
description: File size in bytes
mimeType:
type: string
description: MIME type of file, IANA Standard
example: text/plain; charset=utf-8
examples:
fileNotFound:
summary: File Not Found
description: File Not Found Error Response
value:
apiError:
kind: file_not_found
description: 'File: hello.txt not found'
missingHeaderMetadata:
summary: Missing Header Metadata
description: Error Missing file metadata
value:
apiError:
kind: invalid_header_file
description: Cannot Parse NaN as int64
dataResponse:
summary: Data Response Body
description: Single File Data for Response Body
value:
name: hello.webp
url: https://storage.googleapis.com/...
autoDeleteAt: 1634179200000
privateUrlExpires: 100
isPublic: false
uploadedAt: 1634179200000
updatedAt: 1634179200000
size: 100
mimeType: text/plain; charset=utf-8
internalServer:
summary: Internal Server Error
description: Internal Server Error for Response Body
value:
apiError:
kind: unknown_server_error
description: Unknown Internal Server Error. Unexpected Error
invalidEmptyFile:
summary: Invalid Empty File
description: Invalid Empty File Upload Error Response
value:
apiError:
kind: invalid_empty_file
description: File cannot be empty
requestBodies:
uploadFile:
required: true
description: Binary or text file
content:
application/json:
schema:
nullable: false
description: JSON
type: string
examples:
json:
value:
message: Hello World
image/png:
schema:
nullable: false
description: Image binary
type: string
format: binary
image/jpeg:
schema:
nullable: false
description: Image binary
type: string
format: binary
text/html:
schema:
nullable: false
description: Html Text
type: string
text/plain:
schema:
nullable: false
description: Plain Text
type: string
examples:
text:
value: Hello World
text/javascript:
schema:
nullable: false
description: Javascript Text
type: string
examples:
js:
value: |
console.info('Hello World')
application/xml:
schema:
nullable: false
description: XML Text
type: string
text/csv:
schema:
nullable: false
description: CSV Text
type: string
text/css:
schema:
nullable: false
description: CSS Text
type: string
image/gif:
schema:
nullable: false
description: GIF Image
type: string
format: binary
application/x-sh:
schema:
nullable: false
description: Shell Script text
type: string
examples:
sh:
value: |
#!/bin/sh
echo "Hello World"
image/svg+xml:
schema:
nullable: false
description: SVG Image text
type: string
image/webp:
schema:
nullable: false
description: WebP Image
type: string
format: binary
image/vnd.microsoft.icon:
schema:
nullable: false
description: Icon Image
type: string
format: binary
image/avif:
schema:
nullable: false
description: AVIF Image
type: string
format: binary
application/wasm:
schema:
nullable: false
description: WebAssembly Binary
type: string
format: binary