From a5e405de1625957fd6d5f2f36b49e243760559cd Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Sybren=20A=2E=20St=C3=BCvel?= <sybren@blender.org>
Date: Thu, 13 Jul 2023 10:13:24 +0200
Subject: [PATCH] Web: more SocketIO documentation

Add that the OpenAPI specs also define the structures used for SocketIO
communication.
---
 web/project-website/content/development/socketio/_index.md | 4 ++++
 1 file changed, 4 insertions(+)

diff --git a/web/project-website/content/development/socketio/_index.md b/web/project-website/content/development/socketio/_index.md
index 8c16b906..b363d056 100644
--- a/web/project-website/content/development/socketio/_index.md
+++ b/web/project-website/content/development/socketio/_index.md
@@ -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`.