-
Notifications
You must be signed in to change notification settings - Fork 2.4k
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
write specification for new folder API endpoint
- Loading branch information
1 parent
5ceee81
commit 5d95c73
Showing
3 changed files
with
86 additions
and
0 deletions.
There are no files selected for viewing
5 changes: 5 additions & 0 deletions
5
docs/api/apiv3/components/examples/storage-create-folder-request-body.yml
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,5 @@ | ||
description: |- | ||
A valid request body to create a new folder on a external storage | ||
value: | ||
name: Uploads | ||
parentId: "200" |
13 changes: 13 additions & 0 deletions
13
docs/api/apiv3/components/schemas/storage_folder_write_model.yml
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,13 @@ | ||
# Schema: StorageFolderWriteModel | ||
--- | ||
type: object | ||
required: | ||
- name | ||
- parentId | ||
properties: | ||
name: | ||
type: string | ||
description: Name of the folder to be created | ||
parentId: | ||
type: string | ||
description: Unique identifier of the parent folder in which the new folder should be created in |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,68 @@ | ||
# /api/v3/storages/{id}/folders | ||
--- | ||
post: | ||
summary: Creation of a new folder | ||
operationId: create_storage_folder | ||
tags: | ||
- File links | ||
description: Creates a new folder under the given parent | ||
parameters: | ||
- name: id | ||
description: Storage id | ||
in: path | ||
required: true | ||
schema: | ||
type: integer | ||
example: 1337 | ||
requestBody: | ||
content: | ||
application/json: | ||
schema: | ||
$ref: '../components/schemas/storage_folder_write_model.yml' | ||
examples: | ||
'Valid example': | ||
$ref: '../components/examples/storage-create-folder-request-body.yml' | ||
responses: | ||
'201': | ||
description: Created | ||
content: | ||
application/hal+json: | ||
schema: | ||
$ref: '../components/schemas/storage_file_model.yml' | ||
'400': | ||
content: | ||
application/hal+json: | ||
schema: | ||
$ref: '../components/schemas/error_response.yml' | ||
example: | ||
_type: Error | ||
errorIdentifier: urn:openproject-org:api:v3:errors:InvalidQuery | ||
message: The given parent is not a directory. | ||
description: |- | ||
Returned if the request is missing a required parameter. | ||
'403': | ||
content: | ||
application/hal+json: | ||
schema: | ||
$ref: '../components/schemas/error_response.yml' | ||
example: | ||
_type: Error | ||
errorIdentifier: urn:openproject-org:api:v3:errors:MissingPermission | ||
message: You are not authorized to access this resource. | ||
description: |- | ||
Returned if the client does not have sufficient permissions. | ||
**Required permission:** manage file links | ||
'404': | ||
content: | ||
application/hal+json: | ||
schema: | ||
$ref: '../components/schemas/error_response.yml' | ||
example: | ||
_type: Error | ||
errorIdentifier: urn:openproject-org:api:v3:errors:NotFound | ||
message: The requested resource could not be found. | ||
description: |- | ||
Returned if the storage does not exist or the client does not have sufficient permissions to see it. | ||
**Required permission:** view file links |