mirror of
https://github.com/directus/directus.git
synced 2026-02-16 08:25:10 -05:00
73 lines
1.9 KiB
YAML
73 lines
1.9 KiB
YAML
get:
|
|
description: Retrieve a single folder by unique identifier.
|
|
operationId: getFolder
|
|
parameters:
|
|
- $ref: "#/components/parameters/Fields"
|
|
- $ref: "#/components/parameters/Meta"
|
|
responses:
|
|
"200":
|
|
description: Successful request
|
|
content:
|
|
application/json:
|
|
schema:
|
|
type: object
|
|
properties:
|
|
data:
|
|
$ref: "#/components/schemas/Folder"
|
|
"401":
|
|
$ref: "#/components/responses/UnauthorizedError"
|
|
"404":
|
|
$ref: "#/components/responses/NotFoundError"
|
|
tags:
|
|
- Folders
|
|
patch:
|
|
description: Update an existing folder
|
|
operationId: updateFolder
|
|
parameters:
|
|
- $ref: "#/components/parameters/Fields"
|
|
- $ref: "#/components/parameters/Meta"
|
|
requestBody:
|
|
content:
|
|
application/json:
|
|
schema:
|
|
type: object
|
|
properties:
|
|
name:
|
|
type: string
|
|
description: Name of the folder. Can't be null or empty.
|
|
parent_folder:
|
|
type: integer
|
|
example: 3
|
|
description: Unique identifier of the parent folder. This allows for nested folders.
|
|
responses:
|
|
"200":
|
|
description: Successful request
|
|
content:
|
|
application/json:
|
|
schema:
|
|
type: object
|
|
properties:
|
|
data:
|
|
$ref: "#/components/schemas/Folder"
|
|
"401":
|
|
$ref: "#/components/responses/UnauthorizedError"
|
|
"404":
|
|
$ref: "#/components/responses/NotFoundError"
|
|
tags:
|
|
- Folders
|
|
|
|
delete:
|
|
description: Delete an existing folder
|
|
operationId: deleteFolder
|
|
responses:
|
|
"200":
|
|
description: Successful request
|
|
"401":
|
|
$ref: "#/components/responses/UnauthorizedError"
|
|
"404":
|
|
$ref: "#/components/responses/NotFoundError"
|
|
tags:
|
|
- Folders
|
|
parameters:
|
|
- $ref: "#/components/parameters/UUId"
|