-
-
Notifications
You must be signed in to change notification settings - Fork 186
/
openapi.yaml
579 lines (579 loc) · 14.9 KB
/
openapi.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
openapi: 3.0.1
info:
title: HFS 3
description: ''
version: 1.0.0
tags:
- name: Front-end
paths:
/~/api/get_file_list:
get:
summary: List files
deprecated: false
description: returns all files of a specified folder
tags:
- Front-end
parameters:
- name: uri
in: query
description: path to the folder containing the files. Default is `/`
required: false
schema:
type: string
- name: offset
in: query
description: number of records to skip
required: false
schema:
type: number
- name: limit
in: query
description: max number of records to return
required: false
schema:
type: number
- name: search
in: query
description: search for files with the specified pattern, also in subfolders.
required: false
schema:
type: string
- name: c
in: query
description: >-
request separated `c` and `m` properties in entries. Pass any string
to turn it on. By default only `m` is provided, and when missing it
is copied from `c`.
required: false
schema:
type: string
responses:
'200':
description: all files accordingly to the specified parameters
content:
application/json:
schema:
$ref: '#/components/schemas/inline_response_200'
security: []
/{folder}:
post:
summary: 'Upload '
deprecated: false
description: Equivalent to curl -F upload=@FILE FOLDER/
tags:
- Front-end
parameters:
- name: folder
in: path
description: The folder path where the file will be uploaded
required: true
example: ''
schema:
type: string
- name: x-hfs-anti-csrf
in: header
description: necessary only for POST requests
example: '1'
schema:
type: string
default: '1'
requestBody:
content:
multipart/form-data:
schema:
type: object
properties:
file:
type: string
description: The file to upload.
format: binary
encoding:
file:
contentType: application/octet-stream
responses:
'200':
description: File uploaded successfully
content:
application/json:
schema:
type: object
properties: {}
'400':
description: Bad request
content:
application/json:
schema:
type: object
properties: {}
security: []
/~/api/add_account:
post:
summary: add account
deprecated: false
description: ''
tags: []
parameters:
- name: x-hfs-anti-csrf
in: header
description: necessary only for POST requests
example: '1'
schema:
type: string
default: '1'
requestBody:
content:
application/json:
schema:
type: object
properties:
username:
type: string
password:
type: string
belongs:
type: array
items:
type: string
ignore_limits:
type: boolean
disable_password_change:
type: boolean
admin:
type: boolean
redirect:
type: string
disabled:
type: boolean
expire: &ref_1
$ref: '#/components/schemas/Date'
days_to_live:
type: number
overwrite:
type: boolean
required:
- username
example:
username: john
password: betterUseLongPasswords
overwrite: false
responses:
'200':
description: Success
content:
application/json:
schema:
type: object
properties:
username:
type: string
description: returned because it is normalized
required:
- username
security: []
/~/api/get_config:
get:
summary: get config
deprecated: false
description: ''
tags: []
parameters:
- name: only
in: query
description: to get only specific keys from the config
required: false
schema:
type: array
items:
type: string
- name: omit
in: query
description: to get all but the specified keys from the config
required: false
schema:
type: array
items:
type: string
responses:
'200':
description: Success
content:
application/json:
schema:
type: object
properties: {}
security: []
/{folder}/{file}:
put:
summary: Upload
deprecated: false
description: Equivalent to curl -T FILE URL/
tags:
- Front-end
parameters:
- name: folder
in: path
description: The folder path where the file will be uploaded
required: true
example: ''
schema:
type: string
- name: file
in: path
description: The uploaded file name
required: true
example: ''
schema:
type: string
requestBody:
content:
application/octet-stream:
schema:
type: string
format: binary
responses:
'200':
description: File uploaded successfully
content:
application/json:
schema:
type: object
properties: {}
security: []
/~/api/set_account:
post:
summary: update account
deprecated: false
description: ''
tags: []
parameters:
- name: x-hfs-anti-csrf
in: header
description: necessary only for POST requests
example: '1'
schema:
type: string
default: '1'
requestBody:
content:
application/json:
schema:
type: object
properties:
username:
type: string
changes: &ref_0
$ref: '#/components/schemas/Account'
required:
- username
- changes
example: ''
responses:
'200':
description: Success
content:
application/json:
schema:
type: object
properties:
username:
type: string
description: returned because it is normalized
required:
- username
security: []
/~/api/set_config:
post:
summary: set config
deprecated: false
description: ''
tags: []
parameters:
- name: x-hfs-anti-csrf
in: header
description: necessary only for POST requests
example: '1'
schema:
type: string
default: '1'
requestBody:
content:
application/json:
schema:
type: object
properties:
values:
type: object
properties: {}
required:
- 01HVXZ10SH9AHVGST5XV79TK5A
description: all keys are the defined in config.md file
required:
- values
responses:
'200':
description: Success
content:
application/json:
schema:
type: object
properties: {}
security: []
/~/api/del_account:
post:
summary: delete account
deprecated: false
description: ''
tags: []
parameters:
- name: x-hfs-anti-csrf
in: header
description: necessary only for POST requests
example: '1'
schema:
type: string
default: '1'
requestBody:
content:
application/json:
schema:
type: object
properties:
username:
type: string
required:
- username
example: ''
responses:
'200':
description: Success
content:
application/json:
schema:
type: object
properties: {}
security: []
/~/api/change_srp:
post:
summary: safer update of the password
deprecated: false
description: >-
use SRP protocol to change the password without transmitting it. If your
channel is trusted, you can just specify 'password' in set_account or
add_account, that's much simpler.
tags: []
parameters:
- name: x-hfs-anti-csrf
in: header
description: necessary only for POST requests
example: '1'
schema:
type: string
default: '1'
requestBody:
content:
application/json:
schema:
type: object
properties:
username:
type: string
salt:
type: string
verifier:
type: string
required:
- username
- salt
- verifier
example: ''
responses:
'200':
description: Success
content:
application/json:
schema:
type: object
properties: {}
security: []
/~/api/get_accounts:
get:
summary: list accounts
deprecated: false
description: ''
tags: []
parameters: []
responses:
'200':
description: Success
content:
application/json:
schema:
type: object
properties:
list:
type: array
items: *ref_0
required:
- list
security: []
/~/api/get_usernames:
get:
summary: list usernames
deprecated: false
description: ''
tags: []
parameters: []
responses:
'200':
description: Success
content:
application/json:
schema:
type: object
properties:
list:
type: array
items:
type: string
required:
- list
security: []
/~/api/get_admins:
get:
summary: list admins
deprecated: false
description: ''
tags: []
parameters: []
responses:
'200':
description: Success
content:
application/json:
schema:
type: object
properties:
list:
type: array
items:
type: string
description: username
required:
- list
security: []
/~/api/get_account:
get:
summary: get account
deprecated: false
description: you can also call this with POST
tags: []
parameters:
- name: username
in: query
description: ''
required: false
schema:
type: string
responses:
'200':
description: Success
content:
application/json:
schema: *ref_0
security: []
components:
schemas:
Date:
type: string
format: date-time
Account:
type: object
properties:
username:
type: string
password:
type: string
belongs:
type: array
items:
type: string
ignore_limits:
type: boolean
disable_password_change:
type: boolean
admin:
type: boolean
redirect:
type: string
disabled:
type: boolean
expire: *ref_1
days_to_live:
type: number
required:
- username
folder_body:
type: object
properties:
file:
type: string
description: The file to upload.
format: binary
inline_response_200:
type: object
properties:
can_archive:
type: boolean
description: if you can download this folder as zip
can_upload:
type: boolean
description: if you can upload in this folder
can_delete:
type: boolean
description: if you can delete items in this folder
can_comment:
type: boolean
description: if you can coment items in this folder
list:
type: array
description: entries from this folder
items:
$ref: '#/components/schemas/DirEntry'
DirEntry:
required:
- 'n'
type: object
properties:
'n':
type: string
description: name of the entry. Can be a relative path in case you used `search`.
c:
type: string
description: creation time
format: date-time
m:
type: string
description: modification time
format: date-time
s:
type: number
description: size, in bytes
p:
pattern: '[rR]?[lL]?d?'
type: string
description: |
permissions, only when are different from the parent folder.
Meaning of each character:
- r: cannot be downloaded
- R: can be downloaded only with other credentials
- l: folder cannot be listed
- L: folder can be listed only with other credetnials
- d: can be deleted
comment:
type: string
description: assigned comment
description: >-
front-end list item format. Common properties are kept short to optimize
space.
securitySchemes: {}
servers: []