Skip to content

Commit 2995b46

Browse files
committed
Update openapi.yaml
1 parent fe11452 commit 2995b46

File tree

1 file changed

+33
-41
lines changed

1 file changed

+33
-41
lines changed

docs/api-reference/openapi.yaml

Lines changed: 33 additions & 41 deletions
Original file line numberDiff line numberDiff line change
@@ -178,8 +178,13 @@ components:
178178
DeleteRequest:
179179
type: object
180180
required:
181+
- path
181182
- items
182183
properties:
184+
path:
185+
type: string
186+
description: Current directory path (including storage prefix)
187+
example: "local://uploads"
183188
items:
184189
type: array
185190
items:
@@ -200,9 +205,14 @@ components:
200205
RenameRequest:
201206
type: object
202207
required:
208+
- path
203209
- item
204210
- name
205211
properties:
212+
path:
213+
type: string
214+
description: Current directory path (including storage prefix)
215+
example: "local://uploads"
206216
item:
207217
type: string
208218
description: Current full path of the item to rename (including storage prefix)
@@ -217,6 +227,7 @@ components:
217227
required:
218228
- sources
219229
- destination
230+
- path
220231
properties:
221232
sources:
222233
type: array
@@ -228,6 +239,10 @@ components:
228239
type: string
229240
description: Full destination path (including storage prefix)
230241
example: "local://backup"
242+
path:
243+
type: string
244+
description: Current directory path (including storage prefix)
245+
example: "local://uploads"
231246

232247
ArchiveRequest:
233248
type: object
@@ -279,8 +294,13 @@ components:
279294
CreateItemRequest:
280295
type: object
281296
required:
297+
- path
282298
- name
283299
properties:
300+
path:
301+
type: string
302+
description: Target directory path (including storage prefix)
303+
example: "local://uploads"
284304
name:
285305
type: string
286306
description: Name for the new item
@@ -289,8 +309,13 @@ components:
289309
SaveRequest:
290310
type: object
291311
required:
312+
- path
292313
- content
293314
properties:
315+
path:
316+
type: string
317+
description: Full file path where content should be saved (including storage prefix)
318+
example: "local://uploads/file.txt"
294319
content:
295320
type: string
296321
description: Content to save (as string)
@@ -440,21 +465,14 @@ paths:
440465
summary: Delete files or folders
441466
description: Delete one or more files or folders from the specified path.
442467
operationId: deleteFiles
443-
parameters:
444-
- name: path
445-
in: query
446-
required: false
447-
description: Current directory path (optional)
448-
schema:
449-
type: string
450-
example: "local://uploads"
451468
requestBody:
452469
required: true
453470
content:
454471
application/json:
455472
schema:
456473
$ref: '#/components/schemas/DeleteRequest'
457474
example:
475+
path: "local://uploads"
458476
items:
459477
- path: "local://uploads/file.txt"
460478
type: "file"
@@ -514,21 +532,14 @@ paths:
514532
summary: Rename a file or folder
515533
description: Rename a file or folder to a new name.
516534
operationId: renameFile
517-
parameters:
518-
- name: path
519-
in: query
520-
required: false
521-
description: Current directory path (optional)
522-
schema:
523-
type: string
524-
example: "local://uploads"
525535
requestBody:
526536
required: true
527537
content:
528538
application/json:
529539
schema:
530540
$ref: '#/components/schemas/RenameRequest'
531541
example:
542+
path: "local://uploads"
532543
item: "local://uploads/old-name.txt"
533544
name: "new-name.txt"
534545
responses:
@@ -577,6 +588,7 @@ paths:
577588
schema:
578589
$ref: '#/components/schemas/TransferRequest'
579590
example:
591+
path: "local://uploads"
580592
sources:
581593
- "local://uploads/file1.txt"
582594
- "local://uploads/file2.txt"
@@ -627,6 +639,7 @@ paths:
627639
schema:
628640
$ref: '#/components/schemas/TransferRequest'
629641
example:
642+
path: "local://uploads"
630643
sources:
631644
- "local://uploads/file.txt"
632645
destination: "local://archive"
@@ -764,21 +777,14 @@ paths:
764777
summary: Create a new file
765778
description: Create a new empty file at the specified path.
766779
operationId: createFile
767-
parameters:
768-
- name: path
769-
in: query
770-
required: true
771-
description: Target directory path (including storage prefix)
772-
schema:
773-
type: string
774-
example: "local://uploads"
775780
requestBody:
776781
required: true
777782
content:
778783
application/json:
779784
schema:
780785
$ref: '#/components/schemas/CreateItemRequest'
781786
example:
787+
path: "local://uploads"
782788
name: "new-file.txt"
783789
responses:
784790
'200':
@@ -813,21 +819,14 @@ paths:
813819
summary: Create a new folder
814820
description: Create a new empty folder at the specified path.
815821
operationId: createFolder
816-
parameters:
817-
- name: path
818-
in: query
819-
required: true
820-
description: Target directory path (including storage prefix)
821-
schema:
822-
type: string
823-
example: "local://uploads"
824822
requestBody:
825823
required: true
826824
content:
827825
application/json:
828826
schema:
829827
$ref: '#/components/schemas/CreateItemRequest'
830828
example:
829+
path: "local://uploads"
831830
name: "new-folder"
832831
responses:
833832
'200':
@@ -1058,23 +1057,16 @@ paths:
10581057
tags:
10591058
- Files
10601059
summary: Save content to file
1061-
description: Save text or binary content to a file at the specified path. Overwrites existing file if it already exists. The file path is provided as a query parameter.
1060+
description: Save text or binary content to a file at the specified path. Overwrites existing file if it already exists.
10621061
operationId: saveFile
1063-
parameters:
1064-
- name: path
1065-
in: query
1066-
required: true
1067-
description: Full file path where content should be saved (including storage prefix)
1068-
schema:
1069-
type: string
1070-
example: "local://uploads/file.txt"
10711062
requestBody:
10721063
required: true
10731064
content:
10741065
application/json:
10751066
schema:
10761067
$ref: '#/components/schemas/SaveRequest'
10771068
example:
1069+
path: "local://uploads/file.txt"
10781070
content: "Hello, World!\nThis is the file content."
10791071
responses:
10801072
'200':

0 commit comments

Comments
 (0)