From b535dfed3c13d0e1828c43d681672b8f0ea2403d 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 10:44:27 +0200
Subject: [PATCH] OAPI: expand the description of the `TaskUpdate` schema

No functional changes.
---
 pkg/api/flamenco-openapi.yaml | 6 +++++-
 1 file changed, 5 insertions(+), 1 deletion(-)

diff --git a/pkg/api/flamenco-openapi.yaml b/pkg/api/flamenco-openapi.yaml
index f911d4af..49e27cef 100644
--- a/pkg/api/flamenco-openapi.yaml
+++ b/pkg/api/flamenco-openapi.yaml
@@ -743,7 +743,11 @@ components:
 
     TaskUpdate:
       type: object
-      description: TaskUpdate is sent by a Worker to update the status & logs of a task it's executing.
+      description: >
+        TaskUpdate is sent by a Worker to update the status & logs of a task
+        it's executing. All properties are optional; omitted properties are
+        ignored (i.e. omitting `activity` will not erase the activity property
+        of the task).
       properties:
         "taskStatus":
           $ref: "#/components/schemas/TaskStatus"