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

API: group worker-related endpoints

Browse Source
This commit is contained in:
Sybren A. Stüvel 2022-01-07 17:59:42 +01:00 committed by Sybren A. Stüvel
parent f43673aaa7
commit 3d2263c177
1 changed files with 10 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

14
pkg/api/flamenco-manager.yaml
View File

@ -12,11 +12,12 @@ info:
servers: servers:
- url: / - url: /
paths: paths:
/api/register-worker: /api/worker/register-worker:
summary: Registration of new workers summary: Registration of new workers
post: post:
description: Register a new worker. summary: Register a new worker
operationId: registerWorker operationId: registerWorker
tags: [worker]
requestBody: requestBody:
description: Worker to register description: Worker to register
required: true required: true
@ -38,12 +39,13 @@ paths:
schema: schema:
$ref: '#/components/schemas/Error' $ref: '#/components/schemas/Error'
/api/task: /api/worker/task:
summary: Task scheduler endpoint. summary: Task scheduler endpoint.
post: post:
operationId: scheduleTask operationId: scheduleTask
summary: Obtain a new task to execute. summary: Obtain a new task to execute
security: [{worker_auth: []}] security: [{worker_auth: []}]
tags: [worker]
responses: responses:
"204": "204":
description: No tasks available for this Worker. description: No tasks available for this Worker.
@ -58,6 +60,10 @@ paths:
application/json: application/json:
schema: {$ref: "#/components/schemas/SecurityError"} schema: {$ref: "#/components/schemas/SecurityError"}
tags:
- name: worker
description: API for Flamenco Workers to communicate with Flamenco Manager.
components: components:
schemas: schemas:
WorkerRegistration: WorkerRegistration: