From a32261e196b367ad99a26215bdd8dad75373198f Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Sybren=20A=2E=20St=C3=BCvel?= <sybren@blender.org>
Date: Fri, 20 May 2022 12:58:16 +0200
Subject: [PATCH] OAPI: add task log update schema

Add `SocketIOTaskLogUpdate` schema and add `tasklog` as value for
`SocketIOSubscriptionType`.
---
 pkg/api/flamenco-openapi.yaml | 17 ++++++++++++++++-
 1 file changed, 16 insertions(+), 1 deletion(-)

diff --git a/pkg/api/flamenco-openapi.yaml b/pkg/api/flamenco-openapi.yaml
index 49e27cef..d00e2bab 100644
--- a/pkg/api/flamenco-openapi.yaml
+++ b/pkg/api/flamenco-openapi.yaml
@@ -1275,6 +1275,21 @@ components:
         "activity": { type: string }
       required: [id, job_id, name, updated, status, activity]
 
+    SocketIOTaskLogUpdate:
+      type: object
+      description: >
+        Task log chunk, sent to a SocketIO room dedicated to a single task, to
+        avoid sending too many updates.
+      properties:
+        "task_id":
+          type: string
+          format: uuid
+          description: UUID of the Task
+        "log":
+          type: string
+          description: Chunk of the task log. May contain multiple lines of text.
+      required: [task_id, log]
+
     SocketIOSubscription:
       type: object
       description: >
@@ -1298,7 +1313,7 @@ components:
 
     SocketIOSubscriptionType:
       type: string
-      enum: [job]
+      enum: [job, tasklog]
       description: What kind of thing to subscribe to / unsubscribe from.
 
   securitySchemes: