From 014c0d3b3db65d32e1639fe97598374a0a9c9c02 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Sybren=20A=2E=20St=C3=BCvel?= Date: Wed, 4 Jan 2023 00:46:15 +0100 Subject: [PATCH] OAPI: add field to Job schemas to record storage info Add fields to the job schemas (`SubmittedJob` and `Job`) to allow storing the shaman checkout ID (so the Shaman checkout can be deleted along with the job later). --- pkg/api/flamenco-openapi.yaml | 14 ++++++++++++++ 1 file changed, 14 insertions(+) diff --git a/pkg/api/flamenco-openapi.yaml b/pkg/api/flamenco-openapi.yaml index e717e524..c9633143 100644 --- a/pkg/api/flamenco-openapi.yaml +++ b/pkg/api/flamenco-openapi.yaml @@ -1592,6 +1592,7 @@ components: be interpreted as "the Manager's platform". This is mostly to make test/debug scripts easier, as they can use a static document on all platforms. + "storage": { $ref: "#/components/schemas/JobStorageInfo" } required: [name, type, priority, submitter_platform] example: type: "simple-blender-render" @@ -1650,6 +1651,19 @@ components: "user.email": sybren@blender.org "project": "Sprite Fright" + JobStorageInfo: + type: object + description: > + Storage info of a job, which Flamenco can use to remove job-related + files when necessary. + properties: + "shaman_checkout_id": + type: string + description: > + 'Checkout ID' used when creating the Shaman checkout for this job. + Aids in removing the checkout directory when the job is removed from + Flamenco. + JobsQuery: type: object properties: