-
Notifications
You must be signed in to change notification settings - Fork 1
Expand file tree
/
Copy pathfile-browser.yaml
More file actions
634 lines (632 loc) · 15.6 KB
/
file-browser.yaml
File metadata and controls
634 lines (632 loc) · 15.6 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
openapi: 3.0.1
info:
title: Liara File Browser API Documentaion
description: |-
For managing files in your disks
Parameters:
- `teamID`: To access services in a team
contact:
name: liara
url: https://liara.ir
email: support@liara.ir
version: 1.0.0
externalDocs:
description: Find out more about Liara File Browser
url: https://docs.liara.ir/disks/file-browser/
servers:
- url: https://{filebrowser-url}
variables:
filebrowser-url:
default: Example
description: This value is assigned by the service provider.
security:
- jwt: []
tags:
- name: Disks
description: Everything about your File Browser in Disks
paths:
/v1/projects/{projectID}/disks/{diskName}/list:
get:
tags:
- Disks
summary: Get list from FileBrowser
operationId: getList
parameters:
- name: projectID
in: path
description: The id of your project
required: true
schema:
type: string
- name: diskName
in: path
description: The name of your disk
required: true
schema:
type: string
- name: path
in: query
description: The path of your disk
required: true
schema:
type: string
- name: sortType
in: query
description: The sortType for pagination. valid values:["name", "size", "modTime"]
schema:
type: string
- name: sortDirection
in: query
description: The sortDirection for pagination. valid values:["asc", "desc"]
schema:
type: string
- name: page
in: query
description: The page for pagination. min 1
schema:
type: number
responses:
200:
description: Successful operation
content:
application/json:
schema:
$ref: '#/components/schemas/list'
400:
description: Bad request
content: {}
401:
description: Missing authentication
content: {}
404:
description: App does not exists.
content: {}
500:
description: Unexpected error
content: {}
/v1/projects/{projectID}/disks/{diskName}/search:
get:
tags:
- Disks
summary: Search file or dir in FileBrowser
operationId: search
parameters:
- name: projectID
in: path
description: The id of your project
required: true
schema:
type: string
- name: diskName
in: path
description: The name of your disk
required: true
schema:
type: string
- name: path
in: query
description: The path of your disk
required: true
schema:
type: string
- name: sortType
in: query
description: The sortType for pagination. valid values:["name", "size", "modTime"]
schema:
type: string
- name: sortDirection
in: query
description: The sortDirection for pagination. valid values:["asc", "desc"]
schema:
type: string
- name: page
in: query
description: The page for pagination. min 1
schema:
type: number
- name: targetPath
in: query
description: The targetPath of your disk
schema:
type: string
responses:
200:
description: Successful operation
content:
application/json:
schema:
$ref: '#/components/schemas/search'
400:
description: Bad request
content: {}
401:
description: Missing authentication
content: {}
404:
description: App does not exists.
content: {}
500:
description: Unexpected error
content: {}
/v1/projects/{projectID}/disks/{diskName}/serve:
get:
tags:
- Disks
summary: Serve file from FileBrowser
operationId: serve
parameters:
- name: projectID
in: path
description: The id of your project
required: true
schema:
type: string
- name: diskName
in: path
description: The name of your disk
required: true
schema:
type: string
- name: path
in: query
description: The path of createLink query route
required: true
schema:
type: string
- name: type
in: query
description: The path of createLink query route
required: true
schema:
type: string
- name: token
in: query
description: The path of createLink query route
required: true
schema:
type: string
responses:
200:
description: Successful operation
content: {}
400:
description: Bad request
content: {}
401:
description: Missing authentication
content: {}
404:
description: App does not exists.
content: {}
500:
description: Unexpected error
content: {}
/v1/projects/{projectID}/disks/{diskName}/createLink:
post:
tags:
- Disks
summary: Create link for file in FileBrowser
operationId: createLink
parameters:
- name: projectID
in: path
description: The id of your project
required: true
schema:
type: string
- name: diskName
in: path
description: The name of your disk
required: true
schema:
type: string
- name: path
in: query
description: The path of your disk
required: true
schema:
type: string
- name: type
in: query
description: The type of your request. valid values:["preview", "download"]
schema:
type: string
- name: expire
in: query
description: The expire of your link. valid values:["1h", "6h", "1d", "3d", "7d"]
schema:
type: string
responses:
201:
description: Successful operation
content:
application/json:
schema:
type: object
properties:
queries:
type: object
properties:
path:
type: string
type:
type: string
token:
type: string
400:
description: Bad request
content: {}
401:
description: Missing authentication
content: {}
404:
description: App does not exists.
content: {}
500:
description: Unexpected error
content: {}
/v1/projects/{projectID}/disks/{diskName}/rename:
post:
tags:
- Disks
summary: Rename file or dir in FileBrowser
operationId: rename
parameters:
- name: projectID
in: path
description: The id of your project
required: true
schema:
type: string
- name: diskName
in: path
description: The name of your disk
required: true
schema:
type: string
- name: path
in: query
description: The path of your disk
required: true
schema:
type: string
- name: newName
in: query
description: The newName of your path
schema:
type: string
responses:
201:
description: Successful operation
content: {}
400:
description: Bad request
content: {}
401:
description: Missing authentication
content: {}
404:
description: App does not exists.
content: {}
500:
description: Unexpected error
content: {}
/v1/projects/{projectID}/disks/{diskName}/create:
post:
tags:
- Disks
summary: Create file or dir in FileBrowser
operationId: create
parameters:
- name: projectID
in: path
description: The id of your project
required: true
schema:
type: string
- name: diskName
in: path
description: The name of your disk
required: true
schema:
type: string
- name: path
in: query
description: The path of your disk
required: true
schema:
type: string
- name: type
in: query
description: The type of your request. valid values:["file", "dir"]
schema:
type: string
- name: name
in: query
description: The name of your file or dir
schema:
type: string
responses:
201:
description: Successful operation
content: {}
400:
description: Bad request
content: {}
401:
description: Missing authentication
content: {}
404:
description: App does not exists.
content: {}
500:
description: Unexpected error
content: {}
/v1/projects/{projectID}/disks/{diskName}/extract:
post:
tags:
- Disks
summary: Extract file in FileBrowser
operationId: extract
parameters:
- name: projectID
in: path
description: The id of your project
required: true
schema:
type: string
- name: diskName
in: path
description: The name of your disk
required: true
schema:
type: string
- name: path
in: query
description: The path of your disk
required: true
schema:
type: string
- name: output
in: query
description: The output path of your request
required: true
schema:
type: string
- name: overwrite
in: query
description: The overwrite of your request
schema:
type: string
default: no
responses:
201:
description: Successful operation
content: {}
400:
description: Bad request
content: {}
401:
description: Missing authentication
content: {}
404:
description: App does not exists.
content: {}
500:
description: Unexpected error
content: {}
/v1/projects/{projectID}/disks/{diskName}/upload:
post:
tags:
- Disks
summary: Upload file in FileBrowser
operationId: upload
parameters:
- name: projectID
in: path
description: The id of your project
required: true
schema:
type: string
- name: diskName
in: path
description: The name of your disk
required: true
schema:
type: string
- name: path
in: query
description: The path of your disk
required: true
schema:
type: string
- name: overwrite
in: query
description: The overwrite of your request
schema:
type: string
default: no
requestBody:
content:
multipart/form-data:
schema:
type: object
required:
- file
properties:
file:
type: string
format: binary
responses:
201:
description: Successful operation
content: {}
400:
description: Bad request
content: {}
401:
description: Missing authentication
content: {}
404:
description: App does not exists.
content: {}
500:
description: Unexpected error
content: {}
/v1/projects/{projectID}/disks/{diskName}/delete:
delete:
tags:
- Disks
summary: Delete file or dir in FileBrowser
operationId: delete
parameters:
- name: projectID
in: path
description: The id of your project
required: true
schema:
type: string
- name: diskName
in: path
description: The name of your disk
required: true
schema:
type: string
- name: path
in: query
description: The path of your disk
required: true
schema:
type: string
responses:
202:
description: Successful operation
content: {}
400:
description: Bad request
content: {}
401:
description: Missing authentication
content: {}
404:
description: App does not exists.
content: {}
500:
description: Unexpected error
content: {}
components:
schemas:
list:
type: object
properties:
items:
type: array
items:
type: object
properties:
path:
type: string
name:
type: string
size:
type: number
extension:
type: string
isDir:
type: boolean
isSymlink:
type: boolean
targetSymlink:
type: string
type:
type: string
mode:
type: number
createAt:
type: string
modifiedAt:
type: string
diskName:
type: string
sorting:
type: object
properties:
sortType:
type: string
sortDirection:
type: string
page:
type: number
path:
type: string
name:
type: string
numDirs:
type: number
numFiles:
type: number
size:
type: number
extension:
type: string
isDir:
type: boolean
isSymlink:
type: boolean
targetSymlink:
type: string
type:
type: string
mode:
type: number
createAt:
type: string
modifiedAt:
type: string
search:
type: object
properties:
items:
type: array
items:
type: object
properties:
path:
type: string
name:
type: string
size:
type: number
extension:
type: string
isDir:
type: boolean
isSymlink:
type: boolean
targetSymlink:
type: string
type:
type: string
mode:
type: number
createAt:
type: string
modifiedAt:
type: string
diskName:
type: string
sorting:
type: object
properties:
sortType:
type: string
sortDirection:
type: string
page:
type: number
securitySchemes:
jwt:
type: apiKey
description: 'Enter the token with the `Bearer: ` prefix, e.g. "Bearer abcde12345". #'
name: Authorization
in: header