dndex/public/swagger/v1/entities/idsub.yaml

72 lines
2.0 KiB
YAML

paths:
summary: "Interact with one field of one entity within a namespace"
delete:
description: "Delete an existing entity's field's value"
tags:
- entities
parameters:
- $ref: "#/components/parameters/token"
- $ref: "#/components/parameters/id"
- $ref: "#/components/parameters/path"
responses:
200:
$ref: "#/components/schemas/responseOne"
get:
description: "Get an existing entity's field's value"
tags:
- entities
parameters:
- $ref: "#/components/parameters/token"
- $ref: "#/components/parameters/id"
- $ref: "#/components/parameters/path"
responses:
200:
$ref: "#/components/schemas/responseOne"
put:
description: "Replace an existing entity's field's value"
tags:
- entities
parameters:
- $ref: "#/components/parameters/token"
- $ref: "#/components/parameters/id"
- $ref: "#/components/parameters/path"
requestBody:
$ref: "#/components/schemas/requestOne"
responses:
200:
$ref: "#/components/schemas/responseOne"
patch:
description: "Update an existing entity's field's value"
tags:
- entities
parameters:
- $ref: "#/components/parameters/token"
- $ref: "#/components/parameters/id"
- $ref: "#/components/parameters/path"
requestBody:
$ref: "#/components/schemas/requestOne"
responses:
200:
$ref: "#/components/schemas/responseOne"
components:
parameters:
token:
$ref: "../swagger.yaml#/components/parameters/token"
id:
$ref: "../swagger.yaml#/components/parameters/id"
path:
$ref: "../swagger.yaml#/components/parameters/path"
schemas:
responseOne:
$ref: "../swagger.yaml#/components/schemas/responseOne"
requestOne:
$ref: "../swagger.yaml#/components/schemas/requestOne"
objectOne:
$ref: "../swagger.yaml#/components/schemas/objectOne"
responseOK:
$ref: "../swagger.yaml#/components/schemas/responseOK"