Files
directus/packages/spec/specs/paths/settings/setting.yaml
2020-10-12 14:05:27 -04:00

69 lines
1.9 KiB
YAML

get:
description: Retrieve a single setting by unique identifier.
operationId: getSetting
parameters:
- $ref: "../../openapi.yaml#/components/parameters/Meta"
responses:
"200":
description: Successful request
content:
application/json:
schema:
type: object
properties:
data:
$ref: "../../openapi.yaml#/components/schemas/Settings"
"401":
$ref: "../../openapi.yaml#/components/responses/UnauthorizedError"
"404":
$ref: "../../openapi.yaml#/components/responses/NotFoundError"
tags:
- Settings
patch:
description: Update an existing setting
operationId: updateSetting
parameters:
- $ref: "../../openapi.yaml#/components/parameters/Meta"
requestBody:
content:
application/json:
schema:
properties:
key:
description: Key for the setting
type: string
value:
description: Value for the setting
type: string
type: object
responses:
"200":
description: Successful request
content:
application/json:
schema:
type: object
properties:
data:
$ref: "../../openapi.yaml#/components/schemas/Settings"
"401":
$ref: "../../openapi.yaml#/components/responses/UnauthorizedError"
"404":
$ref: "../../openapi.yaml#/components/responses/NotFoundError"
tags:
- Settings
delete:
description: Delete an existing setting
operationId: deleteSetting
responses:
"200":
description: Successful request
"401":
$ref: "../../openapi.yaml#/components/responses/UnauthorizedError"
"404":
$ref: "../../openapi.yaml#/components/responses/NotFoundError"
tags:
- Settings
parameters:
- $ref: "../../openapi.yaml#/components/parameters/Id"