OAPI: add examples to some schemas
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:
parent
696b97c553
commit
b6c6eee251
@ -1224,6 +1224,11 @@ components:
|
||||
items: { type: string }
|
||||
software_version: { type: string }
|
||||
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:
|
||||
type: object
|
||||
@ -1236,6 +1241,8 @@ components:
|
||||
properties:
|
||||
status: { $ref: "#/components/schemas/WorkerStatus" }
|
||||
required: [status]
|
||||
example:
|
||||
status: "awake"
|
||||
|
||||
AssignedTask:
|
||||
type: object
|
||||
|
Loading…
x
Reference in New Issue
Block a user