From 9d9ff77ee014cc8005ffef2e622eeb298ef89a6c Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Sybren=20A=2E=20St=C3=BCvel?= Date: Tue, 17 May 2022 14:47:33 +0200 Subject: [PATCH] OAPI: add mass-task-refresh option to SocketIO job updates Add `JobUpdate.refresh_tasks` property, to signal to SocketIO clients that the job update is so big, all the job's tasks should be refreshed. This is much faster than sending individual task updates one by one. --- pkg/api/flamenco-manager.yaml | 8 +++++++- 1 file changed, 7 insertions(+), 1 deletion(-) diff --git a/pkg/api/flamenco-manager.yaml b/pkg/api/flamenco-manager.yaml index b027e178..6d1a619e 100644 --- a/pkg/api/flamenco-manager.yaml +++ b/pkg/api/flamenco-manager.yaml @@ -1236,7 +1236,13 @@ components: "previous_status": { $ref: "#/components/schemas/JobStatus" } "type": { type: string } "priority": { type: integer, default: 50 } - required: [id, updated, status, type, priority] + "refresh_tasks": + type: boolean + description: > + Indicates that the client should refresh all the job's tasks. This + is sent for mass updates, where updating each individual task would + generate too many updates to be practical. + required: [id, updated, status, type, priority, refresh_tasks] SocketIOTaskUpdate: type: object