From 23afbfbea2a44d371ee99f3a32ff4d8847c6d4ca Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Sybren=20A=2E=20St=C3=BCvel?= <sybren@blender.org>
Date: Wed, 4 Jan 2023 01:07:43 +0100
Subject: [PATCH] OAPI: add operation `deleteJob`

---
 pkg/api/flamenco-openapi.yaml | 21 +++++++++++++++++++++
 1 file changed, 21 insertions(+)

diff --git a/pkg/api/flamenco-openapi.yaml b/pkg/api/flamenco-openapi.yaml
index c9633143..1deff697 100644
--- a/pkg/api/flamenco-openapi.yaml
+++ b/pkg/api/flamenco-openapi.yaml
@@ -722,6 +722,27 @@ paths:
           content:
             application/json:
               schema: { $ref: "#/components/schemas/Job" }
+    delete:
+      operationId: deleteJob
+      summary: >
+        Request deletion this job, including its tasks and any log files.
+        The actual deletion may happen in the background.
+        No job files will be deleted (yet).
+      tags: [jobs]
+      parameters:
+        - name: job_id
+          in: path
+          required: true
+          schema: { type: string, format: uuid }
+      responses:
+        "204":
+          description: Default response, deletion has been triggered.
+        default:
+          description: Unexpected error.
+          content:
+            application/json:
+              schema:
+                $ref: "#/components/schemas/Error"
 
   /api/v3/jobs/{job_id}/last-rendered:
     summary: Obtain info about the last-rendered images for this job.