drsybren/Flamenco
1
0
Fork 0
Code Issues 1 Pull Requests Actions Packages Projects Releases Wiki Activity

OAPI: rename SocketIOxxx types to Eventxxx types

Browse Source 
Events were previously only sent via SocketIO, but now they can also be
sent via MQTT. These are now renamed from `SocketIO…` to `Event…`.

There is still the SocketIO subscription mechanism, for which the types are
still prefixed with `SocketIO`. MQTT manages subscription on the broker,
not on Flamenco Manager itself, for now this will remain SocketIO-only
functionality.
This commit is contained in:
Sybren A. Stüvel 2024-02-05 09:11:13 +01:00
parent 3326f683da
commit 441079aa06
1 changed files with 16 additions and 13 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

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

@ -2244,14 +2244,14 @@ components:
"status": { $ref: "#/components/schemas/ShamanFileStatus" } "status": { $ref: "#/components/schemas/ShamanFileStatus" }
required: [status] required: [status]
# SocketIO API. These types are not used in any HTTP operation defined in # Events API. These types are not used in any HTTP operation defined in
# the 'paths' section of this document, so some code generators may choose # the 'paths' section of this document, so some code generators may choose
# to skip these. # to skip these.
SocketIOJobUpdate: EventJobUpdate:
type: object type: object
description: > description: >
Subset of a Job, sent over SocketIO when a job changes. Subset of a Job, sent over SocketIO/MQTT when a job changes.
For new jobs, `previous_status` will be excluded. For new jobs, `previous_status` will be excluded.
properties: properties:
"id": "id":
@ -2288,10 +2288,10 @@ components:
If this is specified, only the 'id' field is set, the rest will be empty. If this is specified, only the 'id' field is set, the rest will be empty.
required: [id, updated, status, type, priority, refresh_tasks] required: [id, updated, status, type, priority, refresh_tasks]
SocketIOTaskUpdate: EventTaskUpdate:
type: object type: object
description: > description: >
Subset of a Task, sent over SocketIO when a task changes. Subset of a Task, sent over SocketIO/MQTT when a task changes.
For new tasks, `previous_status` will be excluded. For new tasks, `previous_status` will be excluded.
properties: properties:
"id": "id":
@ -2309,11 +2309,11 @@ components:
"activity": { type: string } "activity": { type: string }
required: [id, job_id, name, updated, status, activity] required: [id, job_id, name, updated, status, activity]
SocketIOTaskLogUpdate: EventTaskLogUpdate:
type: object type: object
description: > description: >
Task log chunk, sent to a SocketIO room dedicated to a single task, to Task log chunk, sent to a MQTT topic/SocketIO room dedicated to a single
avoid sending too many updates. task, to avoid sending too many updates.
properties: properties:
"task_id": "task_id":
type: string type: string
@ -2324,7 +2324,7 @@ components:
description: Chunk of the task log. May contain multiple lines of text. description: Chunk of the task log. May contain multiple lines of text.
required: [task_id, log] required: [task_id, log]
SocketIOLastRenderedUpdate: EventLastRenderedUpdate:
type: object type: object
description: Indicator that the last-rendered image of this job was updated. description: Indicator that the last-rendered image of this job was updated.
properties: properties:
@ -2332,10 +2332,10 @@ components:
"thumbnail": { $ref: "#/components/schemas/JobLastRenderedImageInfo" } "thumbnail": { $ref: "#/components/schemas/JobLastRenderedImageInfo" }
required: [job_id, task_id, thumbnail] required: [job_id, task_id, thumbnail]
SocketIOWorkerUpdate: EventWorkerUpdate:
type: object type: object
description: > description: >
Subset of a Worker, sent over SocketIO when a worker changes. Subset of a Worker, sent over SocketIO/MQTT when a worker changes.
properties: properties:
"id": "id":
type: string type: string
@ -2364,10 +2364,10 @@ components:
description: Whether this Worker can auto-restart. description: Whether this Worker can auto-restart.
required: [id, name, updated, status, version, can_restart] required: [id, name, updated, status, version, can_restart]
SocketIOWorkerTagUpdate: EventWorkerTagUpdate:
type: object type: object
description: > description: >
Worker Tag, sent over SocketIO when it changes. Worker Tag, sent over SocketIO/MQTT when it changes.
properties: properties:
"tag": { $ref: "#/components/schemas/WorkerTag" } "tag": { $ref: "#/components/schemas/WorkerTag" }
"was_deleted": "was_deleted":
@ -2383,6 +2383,9 @@ components:
task updates or task logs they need to explicitly subscribe. For task updates or task logs they need to explicitly subscribe. For
simplicity, clients can only subscribe to one job (to get task updates simplicity, clients can only subscribe to one job (to get task updates
for that job) and one task's log at a time. for that job) and one task's log at a time.
This is not used by MQTT, as with that protocol the subscriptions are
managed by the MQTT broker, not Flamenco.
properties: properties:
"op": { $ref: "#/components/schemas/SocketIOSubscriptionOperation" } "op": { $ref: "#/components/schemas/SocketIOSubscriptionOperation" }
"type": { $ref: "#/components/schemas/SocketIOSubscriptionType" } "type": { $ref: "#/components/schemas/SocketIOSubscriptionType" }