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

Web: more SocketIO documentation

Browse Source 
Add that the OpenAPI specs also define the structures used for SocketIO
communication.
This commit is contained in:
Sybren A. Stüvel 2023-07-13 10:13:24 +02:00
parent b83b929e01
commit a5e405de16
1 changed files with 4 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
web/project-website/content/development/socketio/_index.md
View File

@ -42,5 +42,9 @@ system on the Manager/backend side:
`internal/manager/webupdates/worker_updates.go`
: sending worker-related updates.
`pkg/api/flamenco-openapi.yaml`
: the OpenAPI specification also includes the structures sent over SocketIO.
Search for `SocketIOJobUpdate`; the rest is defined in its vicinity.
For a relatively simple example of a job update broadcast, see
`func (f *Flamenco) SetJobPriority(...)` in `internal/manager/api_impl/jobs.go`.