blender/flamenco
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Use VSCode + Prettier to reformat YAML

Browse Source 
This commit includes settings for Visual Studio Code, so that at least
different people with the same editor (or me on multiple machines) get the
same formatting.

No functional changes.
This commit is contained in:
Sybren A. Stüvel 2022-04-22 12:01:02 +02:00
parent 0cd478a409
commit 634d59e622
3 changed files with 158 additions and 114 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

3
.vscode/extensions.json vendored
View File

@ -2,6 +2,7 @@
"recommendations": [ "recommendations": [
"golang.go", "golang.go",
"alexcvzz.vscode-sqlite", "alexcvzz.vscode-sqlite",
"netcorext.uuid-generator" "netcorext.uuid-generator",
"esbenp.prettier-vscode",
] ]
} }

23
.vscode/settings.json vendored Normal file
View File

@ -0,0 +1,23 @@
{
"go.coverOnSave": true,
"go.coverOnTestPackage": true,
"go.coverOnSingleTest": true,
"go.coverageDecorator": {
"type": "highlight",
"coveredHighlightColor": "rgba(30, 64, 10, 0.06)",
"coveredBorderColor": "rgba(30, 64, 10, 0.06)",
"uncoveredHighlightColor": "rgba(146, 38, 20, 0.06)",
"uncoveredBorderColor": "rgba(146, 38, 20, 0.06)",
"coveredGutterStyle": "blockgreen",
"uncoveredGutterStyle": "blockred"
},
"[yaml]": {
"editor.insertSpaces": true,
"editor.tabSize": 2,
"editor.autoIndent": "keep",
"editor.defaultFormatter": "esbenp.prettier-vscode",
},
"[vue]": {
"editor.defaultFormatter": "johnsoncodehk.volar",
},
}

246
pkg/api/flamenco-manager.yaml
View File

@ -39,7 +39,7 @@ paths:
description: normal response description: normal response
content: content:
application/json: application/json:
schema: {$ref: "#/components/schemas/ManagerConfiguration"} schema: { $ref: "#/components/schemas/ManagerConfiguration" }
## Worker ## Worker
@ -68,14 +68,14 @@ paths:
content: content:
application/json: application/json:
schema: schema:
$ref: '#/components/schemas/Error' $ref: "#/components/schemas/Error"
/api/worker/sign-on: /api/worker/sign-on:
summary: Called by Workers to let the Manager know they're ready to work, and to update their metadata. summary: Called by Workers to let the Manager know they're ready to work, and to update their metadata.
post: post:
summary: Authenticate & sign in the worker. summary: Authenticate & sign in the worker.
operationId: signOn operationId: signOn
security: [{worker_auth: []}] security: [{ worker_auth: [] }]
tags: [worker] tags: [worker]
requestBody: requestBody:
description: Worker metadata description: Worker metadata
@ -96,14 +96,14 @@ paths:
content: content:
application/json: application/json:
schema: schema:
$ref: '#/components/schemas/Error' $ref: "#/components/schemas/Error"
/api/worker/sign-off: /api/worker/sign-off:
summary: Called by Workers to let the Manager know they're going offline. summary: Called by Workers to let the Manager know they're going offline.
post: post:
summary: Mark the worker as offline summary: Mark the worker as offline
operationId: signOff operationId: signOff
security: [{worker_auth: []}] security: [{ worker_auth: [] }]
tags: [worker] tags: [worker]
responses: responses:
"204": "204":
@ -113,13 +113,13 @@ paths:
content: content:
application/json: application/json:
schema: schema:
$ref: '#/components/schemas/Error' $ref: "#/components/schemas/Error"
/api/worker/state: /api/worker/state:
summary: Called by Workers to check whether there is any state change requested. summary: Called by Workers to check whether there is any state change requested.
get: get:
operationId: workerState operationId: workerState
security: [{worker_auth: []}] security: [{ worker_auth: [] }]
tags: [worker] tags: [worker]
responses: responses:
"204": "204":
@ -135,14 +135,14 @@ paths:
content: content:
application/json: application/json:
schema: schema:
$ref: '#/components/schemas/Error' $ref: "#/components/schemas/Error"
/api/worker/state-changed: /api/worker/state-changed:
summary: Called by Workers to let the Manager know they've changed status. summary: Called by Workers to let the Manager know they've changed status.
post: post:
summary: Worker changed state. This could be as acknowledgement of a Manager-requested state change, or in response to worker-local signals. summary: Worker changed state. This could be as acknowledgement of a Manager-requested state change, or in response to worker-local signals.
operationId: workerStateChanged operationId: workerStateChanged
security: [{worker_auth: []}] security: [{ worker_auth: [] }]
tags: [worker] tags: [worker]
requestBody: requestBody:
description: New worker state description: New worker state
@ -159,14 +159,14 @@ paths:
content: content:
application/json: application/json:
schema: schema:
$ref: '#/components/schemas/Error' $ref: "#/components/schemas/Error"
/api/worker/task: /api/worker/task:
summary: Task scheduler endpoint. summary: Task scheduler endpoint.
post: post:
operationId: scheduleTask operationId: scheduleTask
summary: Obtain a new task to execute summary: Obtain a new task to execute
security: [{worker_auth: []}] security: [{ worker_auth: [] }]
tags: [worker] tags: [worker]
responses: responses:
"204": "204":
@ -175,12 +175,12 @@ paths:
description: Task to execute. description: Task to execute.
content: content:
application/json: application/json:
schema: {$ref: "#/components/schemas/AssignedTask"} schema: { $ref: "#/components/schemas/AssignedTask" }
"403": "403":
description: Permission Denied description: Permission Denied
content: content:
application/json: application/json:
schema: {$ref: "#/components/schemas/SecurityError"} schema: { $ref: "#/components/schemas/SecurityError" }
"409": "409":
description: Worker is not in the active state, so is not allowed to execute tasks right now. description: Worker is not in the active state, so is not allowed to execute tasks right now.
"423": "423":
@ -195,13 +195,13 @@ paths:
post: post:
operationId: taskUpdate operationId: taskUpdate
summary: Update the task, typically to indicate progress, completion, or failure. summary: Update the task, typically to indicate progress, completion, or failure.
security: [{worker_auth: []}] security: [{ worker_auth: [] }]
tags: [worker] tags: [worker]
parameters: parameters:
- name: task_id - name: task_id
in: path in: path
required: true required: true
schema: {type: string, format: uuid} schema: { type: string, format: uuid }
requestBody: requestBody:
description: Task update information description: Task update information
required: true required: true
@ -219,7 +219,7 @@ paths:
content: content:
application/json: application/json:
schema: schema:
$ref: '#/components/schemas/Error' $ref: "#/components/schemas/Error"
## Jobs ## Jobs
@ -234,7 +234,7 @@ paths:
description: Available job types description: Available job types
content: content:
application/json: application/json:
schema: {$ref: "#/components/schemas/AvailableJobTypes"} schema: { $ref: "#/components/schemas/AvailableJobTypes" }
/api/jobs/type/{typeName}: /api/jobs/type/{typeName}:
summary: Info about a specific job type. summary: Info about a specific job type.
@ -246,13 +246,13 @@ paths:
- name: typeName - name: typeName
in: path in: path
required: true required: true
schema: {type: string} schema: { type: string }
responses: responses:
"200": "200":
description: Job type description: Job type
content: content:
application/json: application/json:
schema: {$ref: "#/components/schemas/AvailableJobType"} schema: { $ref: "#/components/schemas/AvailableJobType" }
/api/jobs: /api/jobs:
summary: Job submission endpoint. summary: Job submission endpoint.
@ -272,12 +272,12 @@ paths:
description: Job was succesfully compiled into individual tasks. description: Job was succesfully compiled into individual tasks.
content: content:
application/json: application/json:
schema: {$ref: "#/components/schemas/Job"} schema: { $ref: "#/components/schemas/Job" }
default: default:
description: Error message description: Error message
content: content:
application/json: application/json:
schema: {$ref: "#/components/schemas/Error"} schema: { $ref: "#/components/schemas/Error" }
/api/jobs/query: /api/jobs/query:
summary: Obtain jobs with filtering and sorting. summary: Obtain jobs with filtering and sorting.
@ -297,12 +297,12 @@ paths:
description: Normal query response, can be empty list if nothing matched the query. description: Normal query response, can be empty list if nothing matched the query.
content: content:
application/json: application/json:
schema: {$ref: "#/components/schemas/JobsQueryResult"} schema: { $ref: "#/components/schemas/JobsQueryResult" }
default: default:
description: Error message description: Error message
content: content:
application/json: application/json:
schema: {$ref: "#/components/schemas/Error"} schema: { $ref: "#/components/schemas/Error" }
/api/jobs/{job_id}: /api/jobs/{job_id}:
summary: Job info and management summary: Job info and management
@ -314,13 +314,13 @@ paths:
- name: job_id - name: job_id
in: path in: path
required: true required: true
schema: {type: string, format: uuid} schema: { type: string, format: uuid }
responses: responses:
"200": "200":
description: Job info description: Job info
content: content:
application/json: application/json:
schema: {$ref: "#/components/schemas/Job"} schema: { $ref: "#/components/schemas/Job" }
/api/jobs/{job_id}/setstatus: /api/jobs/{job_id}/setstatus:
summary: Request a status change for the given job. summary: Request a status change for the given job.
@ -331,7 +331,7 @@ paths:
- name: job_id - name: job_id
in: path in: path
required: true required: true
schema: {type: string, format: uuid} schema: { type: string, format: uuid }
requestBody: requestBody:
description: The status change to request. description: The status change to request.
required: true required: true
@ -349,7 +349,7 @@ paths:
content: content:
application/json: application/json:
schema: schema:
$ref: '#/components/schemas/Error' $ref: "#/components/schemas/Error"
## Shaman ## Shaman
@ -372,13 +372,13 @@ paths:
description: Subset of the posted requirements, indicating the unknown files. description: Subset of the posted requirements, indicating the unknown files.
content: content:
application/json: application/json:
schema: {$ref: "#/components/schemas/ShamanRequirementsResponse"} schema: { $ref: "#/components/schemas/ShamanRequirementsResponse" }
default: default:
description: unexpected error description: unexpected error
content: content:
application/json: application/json:
schema: schema:
$ref: '#/components/schemas/Error' $ref: "#/components/schemas/Error"
/shaman/checkout/create: /shaman/checkout/create:
summary: Symlink a set of files into the checkout area. summary: Symlink a set of files into the checkout area.
@ -399,25 +399,25 @@ paths:
content: content:
application/json: application/json:
schema: schema:
$ref: '#/components/schemas/ShamanCheckoutResult' $ref: "#/components/schemas/ShamanCheckoutResult"
"424": "424":
description: There were files missing. Use `shamanCheckoutRequirements` to figure out which ones. description: There were files missing. Use `shamanCheckoutRequirements` to figure out which ones.
content: content:
application/json: application/json:
schema: schema:
$ref: '#/components/schemas/Error' $ref: "#/components/schemas/Error"
"409": "409":
description: Checkout already exists. description: Checkout already exists.
content: content:
application/json: application/json:
schema: schema:
$ref: '#/components/schemas/Error' $ref: "#/components/schemas/Error"
default: default:
description: unexpected error description: unexpected error
content: content:
application/json: application/json:
schema: schema:
$ref: '#/components/schemas/Error' $ref: "#/components/schemas/Error"
/shaman/files/{checksum}/{filesize}: /shaman/files/{checksum}/{filesize}:
summary: Upload files to the Shaman server. summary: Upload files to the Shaman server.
@ -430,25 +430,25 @@ paths:
- name: checksum - name: checksum
in: path in: path
required: true required: true
schema: {type: string} schema: { type: string }
description: SHA256 checksum of the file. description: SHA256 checksum of the file.
- name: filesize - name: filesize
in: path in: path
required: true required: true
schema: {type: integer} schema: { type: integer }
description: Size of the file in bytes. description: Size of the file in bytes.
responses: responses:
"200": "200":
description: Normal response. description: Normal response.
content: content:
application/json: application/json:
schema: {$ref: "#/components/schemas/ShamanSingleFileStatus"} schema: { $ref: "#/components/schemas/ShamanSingleFileStatus" }
default: default:
description: unexpected error description: unexpected error
content: content:
application/json: application/json:
schema: schema:
$ref: '#/components/schemas/Error' $ref: "#/components/schemas/Error"
post: post:
operationId: shamanFileStore operationId: shamanFileStore
@ -463,17 +463,17 @@ paths:
- name: checksum - name: checksum
in: path in: path
required: true required: true
schema: {type: string} schema: { type: string }
description: SHA256 checksum of the file. description: SHA256 checksum of the file.
- name: filesize - name: filesize
in: path in: path
required: true required: true
schema: {type: integer} schema: { type: integer }
description: Size of the file in bytes. description: Size of the file in bytes.
- name: X-Shaman-Can-Defer-Upload - name: X-Shaman-Can-Defer-Upload
in: header in: header
required: false required: false
schema: {type: boolean} schema: { type: boolean }
description: > description: >
The client indicates that it can defer uploading this file. The The client indicates that it can defer uploading this file. The
"208" response will not only be returned when the file is already "208" response will not only be returned when the file is already
@ -482,7 +482,7 @@ paths:
- name: X-Shaman-Original-Filename - name: X-Shaman-Original-Filename
in: header in: header
required: false required: false
schema: {type: string} schema: { type: string }
description: > description: >
The original filename. If sent along with the request, it will be The original filename. If sent along with the request, it will be
included in the server logs, which can aid in debugging. included in the server logs, which can aid in debugging.
@ -514,7 +514,7 @@ paths:
content: content:
application/json: application/json:
schema: schema:
$ref: '#/components/schemas/Error' $ref: "#/components/schemas/Error"
tags: tags:
- name: meta - name: meta
@ -550,26 +550,26 @@ components:
type: object type: object
required: [secret, platform, supported_task_types, nickname] required: [secret, platform, supported_task_types, nickname]
properties: properties:
secret: {type: string} secret: { type: string }
platform: {type: string} platform: { type: string }
supported_task_types: supported_task_types:
type: array type: array
items: {type: string} items: { type: string }
nickname: {type: string} nickname: { type: string }
RegisteredWorker: RegisteredWorker:
type: object type: object
properties: properties:
uuid: {type: string, format: uuid} uuid: { type: string, format: uuid }
nickname: {type: string} nickname: { type: string }
address: {type: string} address: { type: string }
status: {$ref: "#/components/schemas/WorkerStatus"} status: { $ref: "#/components/schemas/WorkerStatus" }
platform: {type: string} platform: { type: string }
last_activity: {type: string} last_activity: { type: string }
software: {type: string} software: { type: string }
supported_task_types: supported_task_types:
type: array type: array
items: {type: string} items: { type: string }
required: [uuid, nickname, address, status, platform, current_task, last_activity, software, supported_task_types] required: [uuid, nickname, address, status, platform, current_task, last_activity, software, supported_task_types]
WorkerStatus: WorkerStatus:
@ -579,53 +579,73 @@ components:
WorkerSignOn: WorkerSignOn:
type: object type: object
properties: properties:
nickname: {type: string} nickname: { type: string }
supported_task_types: supported_task_types:
type: array type: array
items: {type: string} items: { type: string }
software_version: {type: string} software_version: { type: string }
required: [nickname, supported_task_types, software_version] required: [nickname, supported_task_types, software_version]
WorkerStateChange: WorkerStateChange:
type: object type: object
properties: properties:
status_requested: {$ref: "#/components/schemas/WorkerStatus"} status_requested: { $ref: "#/components/schemas/WorkerStatus" }
required: [status_requested] required: [status_requested]
WorkerStateChanged: WorkerStateChanged:
type: object type: object
properties: properties:
status: {$ref: "#/components/schemas/WorkerStatus"} status: { $ref: "#/components/schemas/WorkerStatus" }
required: [status] required: [status]
AssignedTask: AssignedTask:
type: object type: object
description: AssignedTask is a task as it is received by the Worker. description: AssignedTask is a task as it is received by the Worker.
properties: properties:
uuid: {type: string, format: uuid} uuid: { type: string, format: uuid }
job: {type: string} job: { type: string }
name: {type: string} name: { type: string }
status: {$ref: "#/components/schemas/TaskStatus"} status: { $ref: "#/components/schemas/TaskStatus" }
priority: {type: integer} priority: { type: integer }
job_priority: {type: integer} job_priority: { type: integer }
job_type: {type: string} job_type: { type: string }
task_type: {type: string} task_type: { type: string }
commands: commands:
type: array type: array
items: {$ref: "#/components/schemas/Command"} items: { $ref: "#/components/schemas/Command" }
required: [uuid, job, name, status, priority, job_priority, job_type, task_type, commands] required: [uuid, job, name, status, priority, job_priority, job_type, task_type, commands]
TaskUpdate: TaskUpdate:
type: object 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.
properties: properties:
taskStatus: {$ref: "#/components/schemas/TaskStatus", description: The new task status.} taskStatus: { $ref: "#/components/schemas/TaskStatus", description: The new task status. }
activity: {type: string, description: One-liner to indicate what's currently happening with the task. Overwrites previously sent activity strings.} activity:
log: {type: string, description: "Log lines for this task, will be appended to logs sent earlier."} {
type: string,
description: One-liner to indicate what's currently happening with the task. Overwrites previously sent activity strings.,
}
log: { type: string, description: "Log lines for this task, will be appended to logs sent earlier." }
JobStatus: JobStatus:
type: string type: string
enum: [active, canceled, completed, construction-failed, failed, paused, queued, archived, archiving, cancel-requested, fail-requested, requeued, under-construction, waiting-for-files] enum:
[
active,
canceled,
completed,
construction-failed,
failed,
paused,
queued,
archived,
archiving,
cancel-requested,
fail-requested,
requeued,
under-construction,
waiting-for-files,
]
TaskStatus: TaskStatus:
type: string type: string
@ -635,8 +655,8 @@ components:
type: object type: object
description: Command represents a single command to execute by the Worker. description: Command represents a single command to execute by the Worker.
properties: properties:
name: {type: string} name: { type: string }
parameters: {type: object} parameters: { type: object }
required: [name, parameters] required: [name, parameters]
AvailableJobTypes: AvailableJobTypes:
@ -645,18 +665,18 @@ components:
properties: properties:
"job_types": "job_types":
type: array type: array
items: {$ref: "#/components/schemas/AvailableJobType"} items: { $ref: "#/components/schemas/AvailableJobType" }
required: [job_types] required: [job_types]
AvailableJobType: AvailableJobType:
type: object type: object
description: Job type supported by this Manager, and its parameters. description: Job type supported by this Manager, and its parameters.
properties: properties:
"name": {type: string} "name": { type: string }
"label": {type: string} "label": { type: string }
"settings": "settings":
type: array type: array
items: {$ref: "#/components/schemas/AvailableJobSetting"} items: { $ref: "#/components/schemas/AvailableJobSetting" }
required: [name, label, settings] required: [name, label, settings]
AvailableJobSetting: AvailableJobSetting:
@ -666,12 +686,12 @@ components:
"key": "key":
type: string type: string
description: Identifier for the setting, must be unique within the job type. description: Identifier for the setting, must be unique within the job type.
"type": {$ref: "#/components/schemas/AvailableJobSettingType"} "type": { $ref: "#/components/schemas/AvailableJobSettingType" }
"subtype": {$ref: "#/components/schemas/AvailableJobSettingSubtype"} "subtype": { $ref: "#/components/schemas/AvailableJobSettingSubtype" }
"choices": "choices":
description: When given, limit the valid values to these choices. Only usable with string type. description: When given, limit the valid values to these choices. Only usable with string type.
type: array type: array
items: {type: string} items: { type: string }
"propargs": "propargs":
description: Any extra arguments to the bpy.props.SomeProperty() call used to create this property. description: Any extra arguments to the bpy.props.SomeProperty() call used to create this property.
type: object type: object
@ -722,11 +742,11 @@ components:
type: object type: object
description: Job definition submitted to Flamenco. description: Job definition submitted to Flamenco.
properties: properties:
"name": {type: string} "name": { type: string }
"type": {type: string} "type": { type: string }
"priority": {type: integer, default: 50} "priority": { type: integer, default: 50 }
"settings": {$ref: "#/components/schemas/JobSettings"} "settings": { $ref: "#/components/schemas/JobSettings" }
"metadata": {$ref: "#/components/schemas/JobMetadata"} "metadata": { $ref: "#/components/schemas/JobMetadata" }
required: [name, type, priority] required: [name, type, priority]
example: example:
type: "simple-blender-render" type: "simple-blender-render"
@ -750,7 +770,7 @@ components:
"project": "Sprite Fright" "project": "Sprite Fright"
Job: Job:
allOf: allOf:
- $ref: '#/components/schemas/SubmittedJob' - $ref: "#/components/schemas/SubmittedJob"
- properties: - properties:
id: id:
type: string type: string
@ -764,8 +784,8 @@ components:
type: string type: string
format: date-time format: date-time
description: Creation timestamp description: Creation timestamp
status: {$ref: "#/components/schemas/JobStatus"} status: { $ref: "#/components/schemas/JobStatus" }
activity: {type: string, description: "Description of the last activity on this job."} activity: { type: string, description: "Description of the last activity on this job." }
required: [id, created, updated, status, activity] required: [id, created, updated, status, activity]
JobSettings: JobSettings:
@ -793,10 +813,10 @@ components:
minimum: 1 minimum: 1
"order_by": "order_by":
type: array type: array
items: {type: string} items: { type: string }
"status_in": "status_in":
type: array type: array
items: {$ref: "#/components/schemas/JobStatus"} items: { $ref: "#/components/schemas/JobStatus" }
description: Return only jobs with a status in this array. description: Return only jobs with a status in this array.
"metadata": "metadata":
type: object type: object
@ -811,21 +831,21 @@ components:
"limit": 5 "limit": 5
"order_by": ["updated", "status"] "order_by": ["updated", "status"]
"status_in": ["active", "queued", "failed"] "status_in": ["active", "queued", "failed"]
"metadata": {project: "Sprite Fright"} "metadata": { project: "Sprite Fright" }
JobsQueryResult: JobsQueryResult:
type: object type: object
properties: properties:
jobs: jobs:
type: array type: array
items: {$ref: "#/components/schemas/Job"} items: { $ref: "#/components/schemas/Job" }
required: [jobs] required: [jobs]
JobStatusChange: JobStatusChange:
type: object type: object
properties: properties:
status: {$ref: "#/components/schemas/JobStatus"} status: { $ref: "#/components/schemas/JobStatus" }
reason: {type: string, description: The reason for this status change.} reason: { type: string, description: The reason for this status change. }
required: [status, reason] required: [status, reason]
Error: Error:
@ -845,13 +865,13 @@ components:
the request can be retried. Following the header is not mandatory, the request can be retried. Following the header is not mandatory,
and it's up to the client to do something reasonable like and it's up to the client to do something reasonable like
exponential backoff. exponential backoff.
message: {type: string} message: { type: string }
SecurityError: SecurityError:
type: object type: object
required: [message] required: [message]
properties: properties:
message: {type: string} message: { type: string }
ShamanRequirementsRequest: ShamanRequirementsRequest:
type: object type: object
@ -859,7 +879,7 @@ components:
properties: properties:
"files": "files":
type: array type: array
items: {$ref: "#/components/schemas/ShamanFileSpec"} items: { $ref: "#/components/schemas/ShamanFileSpec" }
required: [files] required: [files]
example: example:
files: files:
@ -874,7 +894,7 @@ components:
properties: properties:
"files": "files":
type: array type: array
items: {$ref: "#/components/schemas/ShamanFileSpecWithStatus"} items: { $ref: "#/components/schemas/ShamanFileSpecWithStatus" }
required: [files] required: [files]
example: example:
files: files:
@ -889,9 +909,9 @@ components:
type: object type: object
description: Specification of a file in the Shaman storage. description: Specification of a file in the Shaman storage.
properties: properties:
"sha": {type: string, description: "SHA256 checksum of the file"} "sha": { type: string, description: "SHA256 checksum of the file" }
"size": {type: integer, description: "File size in bytes"} "size": { type: integer, description: "File size in bytes" }
"path": {type: string, description: "Location of the file in the checkout"} "path": { type: string, description: "Location of the file in the checkout" }
required: [sha, size, path] required: [sha, size, path]
ShamanFileSpecWithStatus: ShamanFileSpecWithStatus:
@ -913,10 +933,10 @@ components:
type: object type: object
description: Specification of a file, which could be in the Shaman storage, or not, depending on its status. description: Specification of a file, which could be in the Shaman storage, or not, depending on its status.
properties: properties:
"sha": {type: string, description: "SHA256 checksum of the file"} "sha": { type: string, description: "SHA256 checksum of the file" }
"size": {type: integer, description: "File size in bytes"} "size": { type: integer, description: "File size in bytes" }
"path": {type: string, description: "Location of the file in the checkout"} "path": { type: string, description: "Location of the file in the checkout" }
"status": {$ref: "#/components/schemas/ShamanFileStatus"} "status": { $ref: "#/components/schemas/ShamanFileStatus" }
required: [sha, size, path, status] required: [sha, size, path, status]
ShamanCheckout: ShamanCheckout:
@ -925,7 +945,7 @@ components:
properties: properties:
"files": "files":
type: array type: array
items: {$ref: "#/components/schemas/ShamanFileSpec"} items: { $ref: "#/components/schemas/ShamanFileSpec" }
"checkoutPath": "checkoutPath":
type: string type: string
description: > description: >
@ -964,7 +984,7 @@ components:
type: object type: object
description: Status of a file in the Shaman storage. description: Status of a file in the Shaman storage.
properties: properties:
"status": {$ref: "#/components/schemas/ShamanFileStatus"} "status": { $ref: "#/components/schemas/ShamanFileStatus" }
required: [status] required: [status]
# SocketIO API. These types are not used in any HTTP operation defined in # SocketIO API. These types are not used in any HTTP operation defined in
@ -981,15 +1001,15 @@ components:
type: string type: string
format: uuid format: uuid
description: UUID of the Job description: UUID of the Job
"name": {type: string, description: "Name of the job"} "name": { type: string, description: "Name of the job" }
"updated": "updated":
type: string type: string
format: date-time format: date-time
description: Timestamp of last update description: Timestamp of last update
"status": {$ref: "#/components/schemas/JobStatus"} "status": { $ref: "#/components/schemas/JobStatus" }
"previous_status": {$ref: "#/components/schemas/JobStatus"} "previous_status": { $ref: "#/components/schemas/JobStatus" }
"type": {type: string} "type": { type: string }
"priority": {type: integer, default: 50} "priority": { type: integer, default: 50 }
required: [id, updated, status, type, priority] required: [id, updated, status, type, priority]
securitySchemes: securitySchemes: