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).
This commit is contained in:
Sybren A. Stüvel 2023-01-04 00:46:15 +01:00
parent 7f268f2177
commit 014c0d3b3d

View File

@ -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: