Cleanup: reformat long lines in pkg/api/flamenco-manager.yaml

I didn't find the way VSCode was rewrapping those lines the prettiest,
so I manually changed the formatting. It's now still compatible with the
auto-formatting, but nicer.

No functional changes.
This commit is contained in:
Sybren A. Stüvel 2022-05-05 16:00:47 +02:00
parent 84fe14fa46
commit ed2e709618

View File

@ -419,7 +419,8 @@ 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:
@ -617,7 +618,16 @@ components:
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:
type: string type: string
@ -660,43 +670,60 @@ components:
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":
activity: $ref: "#/components/schemas/TaskStatus"
{ description: The new task status.
type: string, "activity":
description: One-liner to indicate what's currently happening with the task. Overwrites previously sent activity strings., 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." } "log":
type: string
description: Log lines for this task, will be appended to logs sent earlier.
JobStatus: JobStatus:
type: string type: string
enum: enum:
[ - active
active, - canceled
canceled, - completed
completed, - construction-failed
construction-failed, - failed
failed, - paused
paused, - queued
queued, - archived
archived, - archiving
archiving, - cancel-requested
cancel-requested, - fail-requested
fail-requested, - requeued
requeued, - under-construction
under-construction, - waiting-for-files
waiting-for-files,
]
TaskStatus: TaskStatus:
type: string type: string
enum: [active, canceled, completed, failed, queued, soft-failed, cancel-requested, paused] enum:
- active
- canceled
- completed
- failed
- queued
- soft-failed
- cancel-requested
- paused
Command: Command:
type: object type: object
@ -832,7 +859,9 @@ components:
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" }
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:
@ -956,7 +985,9 @@ components:
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:
@ -1022,7 +1053,9 @@ components:
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:
@ -1046,7 +1079,9 @@ components:
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]