blender/flamenco
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

OAPI: add examples to some schemas

Browse Source 
Add examples to the `WorkerSignOn` and `WorkerStateChanged` schemas.
These will make it easier to test with SwaggerUI, as they reflect a worker
signing on with the default task types.
This commit is contained in:
Sybren A. Stüvel 2022-07-19 16:52:38 +02:00
parent 696b97c553
commit b6c6eee251
1 changed files with 7 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

7
pkg/api/flamenco-openapi.yaml
View File

@ -1224,6 +1224,11 @@ components:
items: { type: string } items: { type: string }
software_version: { type: string } software_version: { type: string }
required: [name, supported_task_types, software_version] required: [name, supported_task_types, software_version]
example:
# This example may be nice to use from the SwaggerUI interface.
name: API user
supported_task_types: [blender, ffmpeg, file-management, misc]
software_version: swagger-ui
WorkerStateChange: WorkerStateChange:
type: object type: object
@ -1236,6 +1241,8 @@ components:
properties: properties:
status: { $ref: "#/components/schemas/WorkerStatus" } status: { $ref: "#/components/schemas/WorkerStatus" }
required: [status] required: [status]
example:
status: "awake"
AssignedTask: AssignedTask:
type: object type: object