From 4bf235d2f5c5cf2b901e1d43ae129f7b08a09bb5 Mon Sep 17 00:00:00 2001 From: Llewellyn vd Berg <113503285+llewellyn-sl@users.noreply.github.com> Date: Fri, 13 Mar 2026 13:02:57 +0200 Subject: [PATCH 1/2] docs: reconcile platform api workflow docs --- .../docs/describe-workflow.ParamsDetails.json | 2 +- .../docs/describe-workflow.StatusCodes.json | 2 +- .../docs/describe-workflow.api.mdx | 2 +- .../parameter-tables/workflows/parameters.yml | 5 +++-- .../docs/info/workflows.info.api.mdx | 4 ++++ .../docs/list-workflows.ParamsDetails.json | 2 +- .../docs/list-workflows.StatusCodes.json | 2 +- platform-api-docs/docs/list-workflows.api.mdx | 2 +- .../specs/seqera-api-latest-decorated.yml | 22 +++++++++++++------ 9 files changed, 28 insertions(+), 15 deletions(-) diff --git a/platform-api-docs/docs/describe-workflow.ParamsDetails.json b/platform-api-docs/docs/describe-workflow.ParamsDetails.json index 0a3f6a0b3..2b206b1d8 100644 --- a/platform-api-docs/docs/describe-workflow.ParamsDetails.json +++ b/platform-api-docs/docs/describe-workflow.ParamsDetails.json @@ -1 +1 @@ -{"parameters":[{"name":"workflowId","in":"path","description":"Workflow string identifier","required":true,"schema":{"type":"string"}},{"name":"workspaceId","in":"query","description":"Workspace numeric identifier","schema":{"type":"integer","format":"int64"}},{"name":"attributes","in":"query","description":"Comma-separated list of attributes to retrieve. Returns an empty value for each attribute not specified.","explode":false,"schema":{"type":"array","items":{"type":"string","enum":["optimized","labels","messages","minimal","pipelineVersion"],"x-enum-varnames":["optimized","labels","messages","minimal","pipelineVersion"],"title":"WorkflowQueryAttribute"}}}]} +{"parameters":[{"name":"workflowId","in":"path","description":"Workflow string identifier","required":true,"schema":{"type":"string"}},{"name":"workspaceId","in":"query","description":"Workspace numeric identifier","schema":{"type":"integer","format":"int64"}},{"name":"attributes","in":"query","description":"Comma-separated list of attributes to retrieve. Supported values are `optimized`, `labels`, `messages`, `minimal`, and `pipelineInfo`. Returns `null` for each attribute not specified.","explode":false,"schema":{"type":"array","items":{"type":"string","enum":["optimized","labels","messages","minimal","pipelineInfo"],"x-enum-varnames":["optimized","labels","messages","minimal","pipelineInfo"],"title":"WorkflowQueryAttribute"}}}]} diff --git a/platform-api-docs/docs/describe-workflow.StatusCodes.json b/platform-api-docs/docs/describe-workflow.StatusCodes.json index 55d567d97..5a32e07a6 100644 --- a/platform-api-docs/docs/describe-workflow.StatusCodes.json +++ b/platform-api-docs/docs/describe-workflow.StatusCodes.json @@ -1 +1 @@ -{"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"workflow":{"required":["commandLine","projectName","runName","sessionId","submit","userName","workDir"],"type":"object","properties":{"requiresAttention":{"description":"If `true`, the workflow has issues that require user attention.","type":"boolean"},"status":{"description":"Current workflow execution status.","type":"string","enum":["SUBMITTED","RUNNING","SUCCEEDED","FAILED","CANCELLED","UNKNOWN"],"title":"WorkflowStatus"},"ownerId":{"description":"Numeric identifier of the workflow owner.","type":"integer","format":"int64","readOnly":true},"repository":{"description":"Source repository URL or path for the workflow project.","type":"string"},"id":{"description":"Workflow string identifier.","maxLength":16,"type":"string"},"submit":{"description":"Timestamp when the workflow was submitted.","type":"string","format":"date-time"},"start":{"description":"Timestamp when workflow execution started.","type":"string","format":"date-time"},"complete":{"description":"Timestamp when workflow execution completed.","type":"string","format":"date-time"},"dateCreated":{"description":"Timestamp when the workflow record was created.","type":"string","format":"date-time","nullable":true,"readOnly":true},"lastUpdated":{"description":"Timestamp when the workflow record was last updated.","type":"string","format":"date-time","nullable":true,"readOnly":true},"runName":{"description":"Workflow run name. Must be unique within the session.","maxLength":80,"type":"string"},"sessionId":{"description":"Nextflow session identifier for the workflow run.","maxLength":36,"type":"string"},"profile":{"description":"Nextflow profile or profile selection used for the run.","maxLength":100,"type":"string"},"workDir":{"description":"Workflow work directory path.","type":"string"},"commitId":{"description":"Source control commit identifier for the workflow run.","maxLength":40,"type":"string"},"userName":{"description":"Username reported for the workflow owner.","maxLength":40,"type":"string"},"scriptId":{"description":"Internal script or pipeline identifier associated with the run.","maxLength":40,"type":"string"},"revision":{"description":"Source control revision, branch, or tag used for the run.","maxLength":100,"type":"string"},"commandLine":{"description":"Full command line used to launch the workflow.","maxLength":8096,"type":"string"},"projectName":{"description":"Pipeline or project name reported by Nextflow.","maxLength":200,"type":"string"},"scriptName":{"description":"Main workflow script filename.","maxLength":100,"type":"string"},"launchId":{"description":"Legacy launch identifier associated with the workflow.","maxLength":22,"type":"string"},"configFiles":{"description":"Array of configuration files used for the workflow run.","type":"array","items":{"type":"string"}},"params":{"description":"Workflow input parameter map.","type":"object","additionalProperties":true},"configText":{"description":"Inline Nextflow configuration text used for the run.","type":"string"},"manifest":{"type":"object","properties":{"nextflowVersion":{"description":"Nextflow version declared by the pipeline manifest.","maxLength":20,"type":"string"},"defaultBranch":{"description":"Default source control branch declared by the manifest.","maxLength":20,"type":"string"},"version":{"description":"Pipeline version declared by the manifest.","maxLength":20,"type":"string"},"homePage":{"description":"Pipeline homepage URL declared by the manifest.","maxLength":200,"type":"string"},"gitmodules":{"description":"Comma-separated git submodule paths declared by the manifest.","maxLength":150,"type":"string"},"description":{"description":"Pipeline description declared by the manifest.","maxLength":1024,"type":"string"},"name":{"description":"Pipeline name declared by the manifest.","maxLength":150,"type":"string"},"mainScript":{"description":"Main workflow script filename declared by the manifest.","maxLength":100,"type":"string"},"author":{"description":"Pipeline author declared by the manifest.","maxLength":150,"type":"string"},"icon":{"description":"Relative path or URL for the pipeline icon.","maxLength":255,"type":"string"}},"title":"WfManifest","description":"Workflow manifest metadata."},"nextflow":{"description":"Nextflow runtime metadata.","type":"object","properties":{"version":{"description":"Nextflow runtime version used for the workflow run.","maxLength":20,"type":"string"},"build":{"description":"Nextflow build identifier.","maxLength":10,"type":"string"},"timestamp":{"description":"Timestamp associated with the reported Nextflow build.","type":"string","format":"date-time"}},"title":"WfNextflow"},"stats":{"description":"Aggregated workflow task statistics.","type":"object","properties":{"computeTimeFmt":{"description":"Human-readable total compute time across workflow tasks.","maxLength":50,"type":"string"},"cachedCount":{"description":"Number of cached tasks.","type":"integer","format":"int32"},"failedCount":{"description":"Number of failed tasks.","type":"integer","format":"int32"},"ignoredCount":{"description":"Number of ignored tasks.","type":"integer","format":"int32"},"succeedCount":{"description":"Number of successful tasks.","type":"integer","format":"int32"},"cachedCountFmt":{"description":"Human-readable cached task count.","type":"string"},"succeedCountFmt":{"description":"Human-readable successful task count.","type":"string"},"failedCountFmt":{"description":"Human-readable failed task count.","type":"string"},"ignoredCountFmt":{"description":"Human-readable ignored task count.","type":"string"},"cachedPct":{"description":"Percentage of tasks satisfied from cache.","type":"number","format":"float"},"failedPct":{"description":"Percentage of tasks that failed.","type":"number","format":"float"},"succeedPct":{"description":"Percentage of tasks that succeeded.","type":"number","format":"float"},"ignoredPct":{"description":"Percentage of tasks that were ignored.","type":"number","format":"float"},"cachedDuration":{"description":"Aggregate duration in milliseconds for cached tasks.","type":"integer","format":"int64"},"failedDuration":{"description":"Aggregate duration in milliseconds for failed tasks.","type":"integer","format":"int64"},"succeedDuration":{"description":"Aggregate duration in milliseconds for successful tasks.","type":"integer","format":"int64"}},"title":"WfStats"},"fusion":{"description":"Fusion runtime metadata.","type":"object","properties":{"enabled":{"description":"If `true`, Fusion was enabled for the workflow run.","type":"boolean"},"version":{"description":"Fusion version reported for the workflow run.","maxLength":20,"type":"string"}},"title":"WfFusionMeta"},"wave":{"description":"Wave runtime metadata.","type":"object","properties":{"enabled":{"description":"If `true`, Wave was enabled for the workflow run.","type":"boolean"}},"title":"WfWaveMeta"},"errorMessage":{"description":"Summarized task error message associated with the workflow failure.","type":"string"},"errorReport":{"description":"Detailed error report associated with the workflow failure.","type":"string"},"deleted":{"description":"If `true`, the workflow record has been soft-deleted.","type":"boolean","readOnly":true},"projectDir":{"description":"Local project directory used for the workflow run.","type":"string"},"homeDir":{"description":"Home directory used by the workflow runtime.","type":"string"},"container":{"description":"Workflow-level container image.","type":"string"},"containerEngine":{"description":"Container engine used for workflow execution.","type":"string"},"scriptFile":{"description":"Resolved path to the executed workflow script.","type":"string"},"launchDir":{"description":"Directory from which the workflow was launched.","type":"string"},"duration":{"description":"Total workflow duration in milliseconds.","type":"integer","format":"int64"},"exitStatus":{"description":"Final workflow exit status code.","type":"integer","format":"int32"},"resume":{"description":"If `true`, the workflow was launched with resume enabled.","type":"boolean"},"success":{"description":"If `true`, the workflow completed successfully.","type":"boolean"},"logFile":{"description":"Path to the workflow log file.","maxLength":255,"type":"string"},"outFile":{"description":"Path to the workflow standard output file.","maxLength":255,"type":"string"},"operationId":{"description":"Internal operation identifier associated with the workflow launch.","maxLength":110,"type":"string"}},"title":"Workflow"},"progress":{"type":"object","properties":{"workflowProgress":{"required":["aborted","cached","cpuLoad","cpuTime","cpus","failed","ignored","invCtxSwitch","loadCpus","loadMemory","loadTasks","memoryReq","memoryRss","peakCpus","peakMemory","peakTasks","pending","readBytes","retries","running","submitted","succeeded","volCtxSwitch","writeBytes"],"type":"object","properties":{"pending":{"type":"integer","format":"int64"},"submitted":{"type":"integer","format":"int64"},"running":{"type":"integer","format":"int64"},"succeeded":{"type":"integer","format":"int64"},"failed":{"type":"integer","format":"int64"},"cached":{"type":"integer","format":"int64"},"aborted":{"type":"integer","format":"int64"},"retries":{"type":"integer","format":"int64"},"ignored":{"type":"integer","format":"int64"},"memoryEfficiency":{"type":"number","format":"float"},"cpuEfficiency":{"type":"number","format":"float"},"dateCreated":{"type":"string","format":"date-time"},"lastUpdated":{"type":"string","format":"date-time"},"version":{"type":"integer","format":"int64"},"executors":{"type":"array","items":{"type":"string"}},"cpus":{"type":"integer","format":"int64"},"cpuTime":{"type":"integer","format":"int64"},"cpuLoad":{"type":"integer","format":"int64"},"memoryRss":{"type":"integer","format":"int64"},"memoryReq":{"type":"integer","format":"int64"},"readBytes":{"type":"integer","format":"int64"},"writeBytes":{"type":"integer","format":"int64"},"volCtxSwitch":{"type":"integer","format":"int64"},"invCtxSwitch":{"type":"integer","format":"int64"},"loadTasks":{"type":"integer","format":"int64"},"loadCpus":{"type":"integer","format":"int64"},"loadMemory":{"type":"integer","format":"int64"},"peakCpus":{"type":"integer","format":"int64"},"peakTasks":{"type":"integer","format":"int64"},"peakMemory":{"type":"integer","format":"int64"},"cost":{"type":"number"},"netCpus":{"type":"integer","format":"int64"},"netCpuTime":{"type":"integer","format":"int64"},"netCpuLoad":{"type":"integer","format":"int64"},"netMemoryRss":{"type":"integer","format":"int64"},"netMemoryReq":{"type":"integer","format":"int64"},"netMemoryConsumption":{"type":"number"},"netReadBytes":{"type":"integer","format":"int64"},"netWriteBytes":{"type":"integer","format":"int64"},"netVolCtxSwitch":{"type":"integer","format":"int64"},"netInvCtxSwitch":{"type":"integer","format":"int64"},"netCost":{"type":"number"}},"title":"WorkflowLoad"},"processesProgress":{"type":"array","items":{"required":["aborted","cached","cpuLoad","cpuTime","cpus","failed","ignored","invCtxSwitch","loadCpus","loadMemory","loadTasks","memoryReq","memoryRss","peakCpus","peakMemory","peakTasks","pending","process","readBytes","retries","running","submitted","succeeded","volCtxSwitch","writeBytes"],"type":"object","properties":{"pending":{"type":"integer","format":"int64"},"submitted":{"type":"integer","format":"int64"},"running":{"type":"integer","format":"int64"},"succeeded":{"type":"integer","format":"int64"},"failed":{"type":"integer","format":"int64"},"cached":{"type":"integer","format":"int64"},"aborted":{"type":"integer","format":"int64"},"retries":{"type":"integer","format":"int64"},"ignored":{"type":"integer","format":"int64"},"memoryEfficiency":{"type":"number","format":"float"},"cpuEfficiency":{"type":"number","format":"float"},"dateCreated":{"type":"string","format":"date-time"},"lastUpdated":{"type":"string","format":"date-time"},"version":{"type":"integer","format":"int64"},"process":{"type":"string"},"cpus":{"type":"integer","format":"int64","deprecated":true},"cpuTime":{"type":"integer","format":"int64","deprecated":true},"cpuLoad":{"type":"integer","format":"int64","deprecated":true},"memoryRss":{"type":"integer","format":"int64","deprecated":true},"memoryReq":{"type":"integer","format":"int64","deprecated":true},"readBytes":{"type":"integer","format":"int64","deprecated":true},"writeBytes":{"type":"integer","format":"int64","deprecated":true},"volCtxSwitch":{"type":"integer","format":"int64","deprecated":true},"invCtxSwitch":{"type":"integer","format":"int64","deprecated":true},"loadTasks":{"type":"integer","format":"int64","deprecated":true},"loadCpus":{"type":"integer","format":"int64"},"loadMemory":{"type":"integer","format":"int64"},"peakCpus":{"type":"integer","format":"int64"},"peakTasks":{"type":"integer","format":"int64"},"peakMemory":{"type":"integer","format":"int64"}},"title":"ProcessLoad"}},"totalProcesses":{"type":"integer","format":"int32"}},"title":"ProgressData"},"platform":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"}},"title":"ComputePlatformDto"},"jobInfo":{"type":"object","properties":{"id":{"type":"integer","format":"int64"},"operationId":{"type":"string"},"message":{"type":"string"},"status":{"type":"string"},"exitCode":{"type":"integer","format":"int32"}},"title":"JobInfoDto"},"orgId":{"type":"integer","format":"int64"},"orgName":{"type":"string"},"workspaceId":{"type":"integer","format":"int64"},"workspaceName":{"type":"string"},"labels":{"type":"array","items":{"type":"object","properties":{"id":{"type":"integer","format":"int64","description":"Label numeric identifier."},"name":{"type":"string","description":"Label key name."},"value":{"type":"string","description":"Label value."},"resource":{"type":"boolean","description":"Whether this is a resource label (applied to workflow tasks for compute resource allocation)."},"isDefault":{"type":"boolean","description":"Whether this label is automatically applied to new resources by default."},"isDynamic":{"type":"boolean","description":"Whether this label's value can be dynamically computed from workflow metadata."},"isInterpolated":{"type":"boolean","description":"Whether this label contains interpolated variables resolved at runtime."},"dateCreated":{"type":"string","format":"date-time","description":"Timestamp when the label was created."}},"description":"Label object for categorizing and organizing resources (workflows, pipelines, compute environments, actions, datasets).","title":"LabelDbDto"}},"optimized":{"type":"boolean"},"messages":{"type":"array","items":{"type":"string"}}},"title":"DescribeWorkflowResponse"}}}},"400":{"description":"Bad request","content":{"application/json":{"schema":{"required":["message"],"type":"object","properties":{"message":{"type":"string"}},"title":"ErrorResponse"}}}},"403":{"description":"Operation not allowed"}}} +{"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"workflow":{"type":"object","allOf":[{"type":"object","properties":{"messages":{"type":"array","items":{"type":"string"}},"id":{"type":"string"},"ownerId":{"type":"integer","format":"int64"},"submit":{"type":"string","format":"date-time"},"start":{"type":"string","format":"date-time"},"complete":{"type":"string","format":"date-time"},"dateCreated":{"type":"string","format":"date-time"},"lastUpdated":{"type":"string","format":"date-time"},"runName":{"type":"string"},"sessionId":{"type":"string"},"profile":{"type":"string"},"workDir":{"type":"string"},"commitId":{"type":"string"},"userName":{"type":"string"},"scriptId":{"type":"string"},"revision":{"type":"string"},"commandLine":{"type":"string"},"projectName":{"type":"string"},"scriptName":{"type":"string"},"launchId":{"type":"string"},"status":{"type":"string","enum":["SUBMITTED","RUNNING","SUCCEEDED","FAILED","CANCELLED","UNKNOWN"],"title":"WorkflowStatus"},"requiresAttention":{"type":"boolean"},"configFiles":{"type":"array","items":{"type":"string"}},"params":{"type":"object","additionalProperties":true},"configText":{"type":"string"},"manifest":{"type":"object","properties":{"nextflowVersion":{"description":"Nextflow version declared by the pipeline manifest.","maxLength":20,"type":"string"},"defaultBranch":{"description":"Default source control branch declared by the manifest.","maxLength":20,"type":"string"},"version":{"description":"Pipeline version declared by the manifest.","maxLength":20,"type":"string"},"homePage":{"description":"Pipeline homepage URL declared by the manifest.","maxLength":200,"type":"string"},"gitmodules":{"description":"Comma-separated git submodule paths declared by the manifest.","maxLength":150,"type":"string"},"description":{"description":"Pipeline description declared by the manifest.","maxLength":1024,"type":"string"},"name":{"description":"Pipeline name declared by the manifest.","maxLength":150,"type":"string"},"mainScript":{"description":"Main workflow script filename declared by the manifest.","maxLength":100,"type":"string"},"author":{"description":"Pipeline author declared by the manifest.","maxLength":150,"type":"string"},"icon":{"description":"Relative path or URL for the pipeline icon.","maxLength":255,"type":"string"}},"title":"WfManifest"},"nextflow":{"type":"object","properties":{"version":{"description":"Nextflow runtime version used for the workflow run.","maxLength":20,"type":"string"},"build":{"description":"Nextflow build identifier.","maxLength":10,"type":"string"},"timestamp":{"description":"Timestamp associated with the reported Nextflow build.","type":"string","format":"date-time"}},"title":"WfNextflow"},"stats":{"type":"object","properties":{"computeTimeFmt":{"description":"Human-readable total compute time across workflow tasks.","maxLength":50,"type":"string"},"cachedCount":{"description":"Number of cached tasks.","type":"integer","format":"int32"},"failedCount":{"description":"Number of failed tasks.","type":"integer","format":"int32"},"ignoredCount":{"description":"Number of ignored tasks.","type":"integer","format":"int32"},"succeedCount":{"description":"Number of successful tasks.","type":"integer","format":"int32"},"cachedCountFmt":{"description":"Human-readable cached task count.","type":"string"},"succeedCountFmt":{"description":"Human-readable successful task count.","type":"string"},"failedCountFmt":{"description":"Human-readable failed task count.","type":"string"},"ignoredCountFmt":{"description":"Human-readable ignored task count.","type":"string"},"cachedPct":{"description":"Percentage of tasks satisfied from cache.","type":"number","format":"float"},"failedPct":{"description":"Percentage of tasks that failed.","type":"number","format":"float"},"succeedPct":{"description":"Percentage of tasks that succeeded.","type":"number","format":"float"},"ignoredPct":{"description":"Percentage of tasks that were ignored.","type":"number","format":"float"},"cachedDuration":{"description":"Aggregate duration in milliseconds for cached tasks.","type":"integer","format":"int64"},"failedDuration":{"description":"Aggregate duration in milliseconds for failed tasks.","type":"integer","format":"int64"},"succeedDuration":{"description":"Aggregate duration in milliseconds for successful tasks.","type":"integer","format":"int64"}},"title":"WfStats"},"errorMessage":{"type":"string"},"errorReport":{"type":"string"},"deleted":{"type":"boolean"},"projectDir":{"type":"string"},"homeDir":{"type":"string"},"container":{"type":"string"},"repository":{"type":"string"},"containerEngine":{"type":"string"},"scriptFile":{"type":"string"},"launchDir":{"type":"string"},"duration":{"type":"integer","format":"int64"},"exitStatus":{"type":"integer","format":"int32"},"resume":{"type":"boolean"},"success":{"type":"boolean"}},"title":"WorkflowDbDto"},{"properties":{"fusion":{"type":"object","properties":{"enabled":{"description":"If `true`, Fusion was enabled for the workflow run.","type":"boolean"},"version":{"description":"Fusion version reported for the workflow run.","maxLength":20,"type":"string"}},"title":"WfFusionMeta"},"wave":{"type":"object","properties":{"enabled":{"description":"If `true`, Wave was enabled for the workflow run.","type":"boolean"}},"title":"WfWaveMeta"},"logFile":{"type":"string"},"outFile":{"type":"string"},"operationId":{"type":"string"}}}],"title":"WorkflowMaxDbDto"},"progress":{"type":"object","properties":{"workflowProgress":{"required":["aborted","cached","cpuLoad","cpuTime","cpus","failed","ignored","invCtxSwitch","loadCpus","loadMemory","loadTasks","memoryReq","memoryRss","peakCpus","peakMemory","peakTasks","pending","readBytes","retries","running","submitted","succeeded","volCtxSwitch","writeBytes"],"type":"object","properties":{"pending":{"type":"integer","format":"int64"},"submitted":{"type":"integer","format":"int64"},"running":{"type":"integer","format":"int64"},"succeeded":{"type":"integer","format":"int64"},"failed":{"type":"integer","format":"int64"},"cached":{"type":"integer","format":"int64"},"aborted":{"type":"integer","format":"int64"},"retries":{"type":"integer","format":"int64"},"ignored":{"type":"integer","format":"int64"},"memoryEfficiency":{"type":"number","format":"float"},"cpuEfficiency":{"type":"number","format":"float"},"dateCreated":{"type":"string","format":"date-time"},"lastUpdated":{"type":"string","format":"date-time"},"version":{"type":"integer","format":"int64"},"executors":{"type":"array","items":{"type":"string"}},"cpus":{"type":"integer","format":"int64"},"cpuTime":{"type":"integer","format":"int64"},"cpuLoad":{"type":"integer","format":"int64"},"memoryRss":{"type":"integer","format":"int64"},"memoryReq":{"type":"integer","format":"int64"},"readBytes":{"type":"integer","format":"int64"},"writeBytes":{"type":"integer","format":"int64"},"volCtxSwitch":{"type":"integer","format":"int64"},"invCtxSwitch":{"type":"integer","format":"int64"},"loadTasks":{"type":"integer","format":"int64"},"loadCpus":{"type":"integer","format":"int64"},"loadMemory":{"type":"integer","format":"int64"},"peakCpus":{"type":"integer","format":"int64"},"peakTasks":{"type":"integer","format":"int64"},"peakMemory":{"type":"integer","format":"int64"},"cost":{"type":"number"},"netCpus":{"type":"integer","format":"int64"},"netCpuTime":{"type":"integer","format":"int64"},"netCpuLoad":{"type":"integer","format":"int64"},"netMemoryRss":{"type":"integer","format":"int64"},"netMemoryReq":{"type":"integer","format":"int64"},"netMemoryConsumption":{"type":"number"},"netReadBytes":{"type":"integer","format":"int64"},"netWriteBytes":{"type":"integer","format":"int64"},"netVolCtxSwitch":{"type":"integer","format":"int64"},"netInvCtxSwitch":{"type":"integer","format":"int64"},"netCost":{"type":"number"}},"title":"WorkflowLoad"},"processesProgress":{"type":"array","items":{"required":["aborted","cached","cpuLoad","cpuTime","cpus","failed","ignored","invCtxSwitch","loadCpus","loadMemory","loadTasks","memoryReq","memoryRss","peakCpus","peakMemory","peakTasks","pending","process","readBytes","retries","running","submitted","succeeded","volCtxSwitch","writeBytes"],"type":"object","properties":{"pending":{"type":"integer","format":"int64"},"submitted":{"type":"integer","format":"int64"},"running":{"type":"integer","format":"int64"},"succeeded":{"type":"integer","format":"int64"},"failed":{"type":"integer","format":"int64"},"cached":{"type":"integer","format":"int64"},"aborted":{"type":"integer","format":"int64"},"retries":{"type":"integer","format":"int64"},"ignored":{"type":"integer","format":"int64"},"memoryEfficiency":{"type":"number","format":"float"},"cpuEfficiency":{"type":"number","format":"float"},"dateCreated":{"type":"string","format":"date-time"},"lastUpdated":{"type":"string","format":"date-time"},"version":{"type":"integer","format":"int64"},"process":{"type":"string"},"cpus":{"type":"integer","format":"int64","deprecated":true},"cpuTime":{"type":"integer","format":"int64","deprecated":true},"cpuLoad":{"type":"integer","format":"int64","deprecated":true},"memoryRss":{"type":"integer","format":"int64","deprecated":true},"memoryReq":{"type":"integer","format":"int64","deprecated":true},"readBytes":{"type":"integer","format":"int64","deprecated":true},"writeBytes":{"type":"integer","format":"int64","deprecated":true},"volCtxSwitch":{"type":"integer","format":"int64","deprecated":true},"invCtxSwitch":{"type":"integer","format":"int64","deprecated":true},"loadTasks":{"type":"integer","format":"int64","deprecated":true},"loadCpus":{"type":"integer","format":"int64"},"loadMemory":{"type":"integer","format":"int64"},"peakCpus":{"type":"integer","format":"int64"},"peakTasks":{"type":"integer","format":"int64"},"peakMemory":{"type":"integer","format":"int64"}},"title":"ProcessLoad"}},"totalProcesses":{"type":"integer","format":"int32"}},"title":"ProgressData"},"platform":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"}},"title":"ComputePlatformDto"},"jobInfo":{"type":"object","properties":{"id":{"type":"integer","format":"int64"},"operationId":{"type":"string"},"message":{"type":"string"},"status":{"type":"string"},"exitCode":{"type":"integer","format":"int32"}},"title":"JobInfoDto"},"orgId":{"type":"integer","format":"int64"},"orgName":{"type":"string"},"workspaceId":{"type":"integer","format":"int64"},"workspaceName":{"type":"string"},"labels":{"type":"array","items":{"type":"object","properties":{"id":{"type":"integer","format":"int64","description":"Label numeric identifier."},"name":{"type":"string","description":"Label key name."},"value":{"type":"string","description":"Label value."},"resource":{"type":"boolean","description":"Whether this is a resource label (applied to workflow tasks for compute resource allocation)."},"isDefault":{"type":"boolean","description":"Whether this label is automatically applied to new resources by default."},"isDynamic":{"type":"boolean","description":"Whether this label's value can be dynamically computed from workflow metadata."},"isInterpolated":{"type":"boolean","description":"Whether this label contains interpolated variables resolved at runtime."},"dateCreated":{"type":"string","format":"date-time","description":"Timestamp when the label was created."}},"description":"Label object for categorizing and organizing resources (workflows, pipelines, compute environments, actions, datasets).","title":"LabelDbDto"}},"optimized":{"type":"boolean"},"messages":{"type":"array","items":{"type":"string"}},"pipelineInfo":{"type":"object","properties":{"id":{"type":"integer","format":"int64","description":"Pipeline numeric identifier."},"workspaceId":{"type":"integer","format":"int64","description":"Workspace numeric identifier where the pipeline is located."},"version":{"description":"Pipeline version information.","type":"object","properties":{"id":{"type":"string","description":"Pipeline version string identifier."},"name":{"type":"string","description":"Pipeline version name."},"dateCreated":{"type":"string","format":"date-time","description":"Date and time the version was created, in ISO 8601 format."},"lastUpdated":{"type":"string","format":"date-time","description":"Date and time the version was last updated, in ISO 8601 format."},"hash":{"type":"string","description":"Git commit hash for this version."},"isDefault":{"type":"boolean","description":"Whether this version is the default version."},"isDraftVersion":{"type":"boolean","description":"Whether this version is a draft (unpublished) version."}},"title":"PipelineMinInfoResponse.PipelineVersionMinInfoResponse"}},"title":"PipelineMinInfoResponse"}},"title":"DescribeWorkflowResponse"}}}},"400":{"description":"Bad request","content":{"application/json":{"schema":{"required":["message"],"type":"object","properties":{"message":{"type":"string"}},"title":"ErrorResponse"}}}},"403":{"description":"Operation not allowed"}}} diff --git a/platform-api-docs/docs/describe-workflow.api.mdx b/platform-api-docs/docs/describe-workflow.api.mdx index 59f29be73..58b801d80 100644 --- a/platform-api-docs/docs/describe-workflow.api.mdx +++ b/platform-api-docs/docs/describe-workflow.api.mdx @@ -5,7 +5,7 @@ description: "Retrieves the details of the workflow record associated with the g sidebar_label: "Describe workflow" hide_title: true hide_table_of_contents: true -api: eJztHF1z2zbyr2Dwcu0M43w07dz56RzZaX1nOz5/tA+ZzAQiVxISEmAAULbq0X+/WQCkQBGSwOR6D3d9MkUu9huLxQLrJ2rYXNPj9/RBqs+zUj5o+iGjBehc8dpwKegxvQGjOCxBE7MAUoBhvNREzuzPdhxRkEtVEKa1zDkzUJAHbhYWZs6XIMjHFvS8+HhEMyprUAxJnBf0mJ5aklP4zQPRjNZMsQoMKGTwiQpWAT2mGyw0oxz5q5lZ0G2mWzxEG8XFnPAChOEzDopmVMGXhiso6LFRDWRU5wuoGD1+omZVIxE3iK7XWY+urlkOG8JfGlCrKGULSERTgeJ5n/aAFhcG5vbTTKqKGffqp9c96swYxaeNAb2f+ERWFXumAXWHNii5NmiqzXhiJFHeokfkBkyjhCZMEKhqsyJLVjZAZlIRYPliM44IaYiuIUc5CrQfPNalLIAez1ipY0pkSjHkkBuo9FC5GQXRVOh7sja84r8DKrZkUyhRyAq0ZnMrb8UFr1iJLsFrKLmAX0FpFPhDRh+fIZpnS6ZQVfqb8RluSggc6F+o55NWDXS9Xn9AB9K1FBqsWK9evMA/fUO8+yfNaC6FAWHwK6vrkufW359/0gjyNNSYnH6C3CBfCmeH4Y5A6/L4vHHd9zRHY4viggtwY3D0FTpMRlUj/JMGrd0sy6huphVHAo0G5b8j9lOurOx72fCk9YlBobiToS/1+Yx8xCn1MesHhwXThGvd2BjCDPGoCLKBPubwoVd5FqZSlsAEXWdUG2YaPaQ1aZQCYTZE4BHyBj8SNyRAN3C52/s3l+d3d2enNKM391dX51c/04ze3k8mZ2en9u3bk/ML+zA5uZqcXbjn+6t/Xr377SrmJ7eOzXVG5YMAhUFtm+OrQTwYRFE7NmB8Z3BAH2TFO1GuXBBb44taam6kWg1J38pG5UA2IOT+5oJIRTB42uneY8P70lCD64zyiGS7oy2iqNjjBYi5WdDjlz9FMHqvHGC94xVow6qaPCxA9Dl8YJq4ccaFo21Ld/oqmIFnhlfgnUkdphR3KTWKUi6rugQDX0OsHTuCHP6YKMCgP06Rft1GfeZufCLRjIqmLNkUZ4FbRgceWTJt7uvim5hCHKRxSP5znLXhcbcnq0YQXFGOyGWjDZkCaQT/0oBNa7jj14fWLR//64uYj3dReBgW4NG4yeNgwvgwmJmq2Sb3Q2xK1UrOeBmRryPmIWwM8I8aSsitAzYaio72kOTLFzER24Vkt04RghRcQW5DEMaeaIjBhY2bmK58HMOFVcmSOMCRCnsdY75bEAck7zXY1MIGT4wBQxpd1D5ExeGNCXYuDJIpiXtpzeKTk1C8WHqdKKGCJdfRVXtLqS1gRqaKiXyRITOGzb/OK8IkZUD5bVM6IzKBuaoAR8NIUrJG5IuemgfT7G87PL9Lgwb0rluVOq9HQNK37XRF2imyRe9VVDyHPU7tkvEgvHvD4kyzcSVFeU4LMX+5gDnLV62aDnjIDg2+ehW1l5jx+VteQiTnOsGUHpMWB9W4DZyVSffdY3v+pe0J1mu/7YvQ7qIIF3VjSLc7JBWrAwpd8sqKguNQVl4HaayP/47/O3iMJAPnwrpIFyn7shp4NNGZMNBkxQSfgTaHE3zhSbXbkN1Re+kgSAF5yZTzV+ShixUt0YHzRhgsYMaa0ryxs3xI9NR9JrofHlxQGHAwhvByl5zd/Nwl5xgqC1nBNZvvCwMIUrM52Gw4mVaM2JybShZNdNZsb8rn3Njc1cLbVVCnEn/5Y9yQAbmdwgavk8m9ePU6Qk/sD642on6TQBXj4taiHhlV0wWLkWWNWchIAtNJ5gC+TTaex6x0AyUzfOncAZcn9Mg2wmwygXyQbb768ccBkXWwPZ1dtmFoZ4msZZ9UYFjBDDuyRvYxZ080Uo3AhDsYd6iGsHPmD3C2EWDvqnIoBEwbXu7LuO33PbvVGE7T7lv2bWmieVqbY/TJp+7xekZtUbQFkthaPZ8rmDsWWrUZpj/b6gjXhuf6sL1wJ9oYQMHeVpHJ+EtTMfEMt1e43SJGGmYTOhxErB1ZrqTWfRb0lp6j8yRn+QKKiWxEhO5VU01d+cSBbdDuLZz88AoxzxgvEzA7sFGY+VxIlYDaw43CrZs8hwTcFk7rWVOOQh+oO8XSgdpJjoOiKVDIcwrWLd73YA5smII4sOUepKH5UrCGZtyD1unqOo8gvAaVgzCYgmApEO1FNE5PrLKTmZKV03SAV1hLhzaclZKZjVKSCdlSrBuTht+bcxwBPyiVhtfpOBoPoDprpJFxNjn1Wf2e6EmKNvPnglS8LLmGXIpC20VpVPTBM53WSN9MeVR0cpS9Jb6Z9OgI4w6zguXr1i5ZqIwmng68te+/IsEAgTMzVmDZHE145Fhd9OCHtq3BccTODMZjbfOW3dWipNylpy6H+hIMs3U2towVLtkS/iB9WdRfo62eEIilFQGUkurSnchF6lFNVTGFB3guslpo4g/w9hY47KxoFETDsEVzY80S2+waN6EcMWe9r6dVgK3fp5+Q+Yo3HpRNAQTRcmaeeSwR1UZK2r6eFa3AXsiclV3Fa1OBTSnZ9DfUUfS/SNx59bH6rVGIFF1zR71XGMYF7KkdPythCSXpIAmv2PwAtjMxj1YdJx0SsBAbNQzPYuJpjUX2NlpgvwEtyyUUbiNnpNWCQxdm4m5IFLur6UUVfdrp2KYGDwu+VSP1RyaIIHZcgp65M/rf2eS9w7RrCUhcbOCRm9sdR7dvuQgpIag/syW5LCAxY1Wgm1gdYtcUC1XjprPD0Ia1HcfPbrFLJ9Md3gXrZLmKIy/lPO5F14HzdJhLObeFjoQKQEZls8NBo6i1YaJgqiCyMVhdTScT3uLZeajRQaVWqr2htvfjkQ35engU748B5srbLe12xXUwIrxlwaZ2HadtzogPdXMhmX+6c0eOed3g3RKXltEuj7XXdZYT83j7wE2O95RKyYqJA8bHS6ikvciDP+4wnbKXVfDlDXzZPGt8XwP77MfiYzcWf7RjaxCFqyLgEvFm5e4MuSs/2t0MEe57d35Ou9zQPi9lGTL8oLgBh+fgHZGWeMr1ppCBNPiW9VTsrUhp8N50acDeF9KAWxdKlNKbKg269bM0aOdMZ7MZzzmIfBUM27dZqpuxQ7buI6RdYti6L5A2KEjIk5YlXImlCtWbcChlZ3eiZ/iQkAxtQ8kY893oVF42cSTV9dqIkQYfhIa0Ab3QkujgYfhMG7IJpenwk3QLB2E7bUAXttPBx7AfLAWJTid7p5J+GtuavxnBp4Me4exuwAh/F2AuR7r8Zkiy13dDJlLopurO0WLquRk5QwSY38ZOEgHm1/HzRIA5Hz9V0CRxb4gkVtZyLrnCxBb09TDLGgTT/41cyov8Z1b1Z1b1Z1Y1XIH87BjmTumpExbNagW547O9p5O+vuwan7rcRMePSrj2YUhbjKIYRiVlUQzj0rQoirGJWxTJ2FQuimRUcrcTw/9Puhes49dumrplHN9jxe+6XcwPYsOyWx+bXfxPmSvq1yUzCH645MIjgSi4VrS7wjNxNwuuPaVTI3HcJzk9FzM5ku4+FW9VtQacVpuji2FxuCt6Dk8gHrmZ2J6pcZr+hxPQiyvV/DxZEDW/ims163W0JW732hE7cfp2q8N762+y0PZNpgukGmm3O9rtVXEUn2HlLv3bJRBb4VJHWuAjX5a2FyaDkZtTm63DjQWYBeDpC8f+KMJIO5hYRZLvbNuYuxHdv0HjTp/9RZtuFCtL6ZrMvre8cO0vcY5lxpFHlhojK2Z4zspyRQJ2BDx0dDWe9vjbpC3dlWAVz7+K7l+0b0PMmcDGi8Lhshx4kf3diE4nvZtrXNvCcy3LrZxnhOj+EEkTHqAiS6Y4nhVoK7o95sFutvZo66sytG1mIn0xjqVei856+9qn90M3r/zdBANzqfjv2JGFF+ylmjPhfm4s913X+Zt19wx11rkWiCVXUlQgjM4Is+0hOiOoaw1Gf2/PNXyYshycTm2YskG0bcMcWmAdNGSOKMQFMXG7YfjGt2Qi1Dqjr2NNmW9YYVsP3W3I5O7McAfbRv6De7bdS0QgxJk7kt7i/Ich5++6AxTsw8Vp/gBuDdeQN4qble2RfgNMgTpp8LDk/QfsVK3ALCQ2WM/B8oi90sf0eWv050+bfuq1bRZVy7bhulElPaYLY2p9/Pw5q/lRXsqmONLwBRQ74nLgurf2C2mXZzJBeHJyfU6RlZbTW1SsU1LIb6cnpNg2SlufsUA08w9v2yn06cFYDfB27fdK9Vwg2UMMorgcZ4EDtpPeXTzqCx+KDBXjpV2KZvLvmw/hnom+PHr58sejFzYrktpUzHqU7+VuPbeLXttsPm1c849qvveqxmaG53XJuJ2RVuYn7yObfwlAM3ocdN1/wIsAWDF6T5+epkzDvSrXa3ztWtLRdQqu/bUS3xy+U74D3fJRPj/DatCQ7xdrSrFpPp38f7Fffo8ove7+jSQf8IdbcEZq9bsbH7K+J3v/EUKUpzYYi1XITah27wnrD3gpBFiBFzfeP3mAkzyH2gRDB8G1F5d+Pruj7uZ9uEz0p7zFHmXr6clB3MnPINbrjkuDv5HB9frfw09A+Q== +api: eJztG11z2zjur3D4cu2M6n7sducmT5c6aS+3SZrLR/vQyUxoCbbZSqRKUk6yGf/3G5CULFmUQzW3N3N3fbIsgQAIgAAIgg/UsIWme1/orVTf5rm81fQ6oRnoVPHScCnoHj0HozisQBOzBJKBYTzXRM7t33ocUZBKlRGmtUw5M5CRW26WFmbBVyDITQ16lN1MaEJlCYohiaOM7tEDS3IGnz0QTWjJFCvAgEIGH6hgBdA9usFCE8qRv5KZJd1musZDtFFcLAjPQBg+56BoQhV8r7iCjO4ZVUFCdbqEgtG9B2ruSyTiBtH1OunQ1SVLYUP4ewXqPkjZAhJRFaB42qXdo8WFgYX9NJeqYMa9+u3XDnVmjOKzyoDeTXwqi4K90ICyQx3kXBtU1WY8MZIor9EJuajKUiqEXLG8Ak2YAnIjS8ML/gdkNwm5ydkMco1PBWjNFuCeueAFy28SwkRGbkpeQs4FHIm5vJmQczCVEprciCrPb8hcKgIsXW7YIEIaoktIUSwZmgPclbnMgO7NWa5DOmFKMZwwN1Dovq4SCqIq0JQb7mlCHfM0oTXv+OhYRwtrcY12f/cCcbxYMYVi109DZrjJoWWJ/0SF7dcCoOv1+hotUZdSaLATevPqFf50Nfrxd5rQVAoDwuBXVpY5T+3CeflVI8hDX1Zy9hVSg0wpXGaGOwL12glBsjz/OLcLbTeOZu7RmlmvE8qzwPuEylsB6iiLWg0J1dWs4Cak+gY2YwZeGF6AhTdMjQBPZVHmYCB+BP6ZKsCVFj8oZ9pcldm4QaoSp9YTBISoQWvvRgNfSyXnPA+PRHs44Cr4LZVFwc0A0kqDGubHWu/ASAUrrrkz2yBNJrJjLsKYSyXRJh+hPPg5Z5VIlwOMacNMtdOvXFy9Ozm6vDw8oAk9vzo9PTr9QBN6cTWdHh4e2Lfv94+O7cN0/3R6eOyer05/P/34+TTkEi4czXUTkfS+wXXelc9MyhyYcAISc754z/Ox68/GUh1c91nGkSDLz1rrHONiQ+8S7gLLaJ3Qggk+B20e9zwC7gzO+BOoWvtdN3fqAcjKQZAM0pwpyMjs3iYRtXslNVEMGgW7OwaxMEu69+ZV0mcwgzmrcvNOMZEu+0QP3GeiZaVSIOhllczJzIL3OBhDeDU0z7N6GkPzHENlKQs4YwvYQQZBSrYAcnV+HE8rRGzBTSGzypve7rRjwQ1Bb23hCSZoOpb467dhRbbIDU629Tqa3Ks3vwboCe9DBgjh56dNqGBcXFjUfTInjItNYu2+EHTio8gGlcgqs5Rqx8wcwNPmxtOQls4hZ4avnDkQqaxFYmbYWd04dtsc377tEVm3nOn8pHZDqDjvRx53SYNLtHFFqhIYf5ulWmnIGo43G5+qx3BIKLOK59kOYvZ7a6vQU2cAJ3KnDSvKPt7L+lNwR6bAZ/1d8kgzJh/pSL9GUQfRYJTpih4zrcoA8vi+CCyAv1cFEy8UsIzNciBGGpYTP4hYlbBUSa03SjBMf9NbIgvaZsrSJWRTWYkA3dOqmIHC/ZID26DdmZ3+8gYxzxnPIzA7sFGY+UJIFYHaw43Cras0hQjcFk7reZWPQt8Sd4ymW2InKQ7qW+QWzzFYt3jfgbmlwxjELV3uQNpWXwzWthp3oHWyOksDCM9ApSAMhn0s06C+iGaGa9xsk7mShZN0C6+wmm7rcJ5LZjZCiSZklsx4ycTh9+ocR8APiqXhZTqOxi2oRhtxZJxODipX2OqT2l8sFCyYAZJ5GMIFKXiecw2pFJm28WWU93F7YyfwJ1Me5Z3qXbnVxJNJj/YwrkTWikQXNvqsEwpKSXXiChXBjYsFOLdBMPg9AywEtDeKrU2Y34UObZwx4x7eVAvDuIDwV4zKmhup7ncPPhSLoR2yk/v7oQ2/2wEPcZe1VBiheLjj5mJ717wrGCjQVWdr3hKq137o47q/cT6YHRhJsT7aTSzm1VZtYSABAYGeNpCOHc3JDe59bxLy3uIit0wTDz6Y+/WnM5hceqx1StkkYj+WVnbM36E+AcNsbYet4N8jiM9sBT8khg53iKXmLZeLQROV1bD5do4M+mWOdaDEcsLuamPBqS9U18geKZSetUZsDg2+UDazWqO1x8eHsjqWzD9hZuuesEbsnCptopAt4a+m5u7ilpsUzy5yybKpA8bHEyikLe7jn0t0hrbojC/P4fvmWeP7Etg3PxYfm7H4px5bgshcOo9Zxrt7d47gjgHsUyWE++5qrG5uTYylCV3JvM3wreIGHJ7r5BFh1sTHFHm7zncXfM16LPZ6SnHwXnVxwN4W4oBrE4qcpVdVHHRtZ3HQzpgO53OechBpO/jsSnXKauyQ/1y5vOV+owIZpJWRamRN1a7uSMvwLiEa2rqSMeo717G8bPxIrOnVHiMOvuUa4gZ0XEukgbfdZ9yQjSuNh5/Ga7jltuMGNG47HnwM+61QEGl0slPH98vYVtTMCD4d9AhjdwNG2LsAczLS5DdDoq2+GTKVQldFuZUXd8RzPnKFCDCfxy4SAebT+HUiwByNXyqokrA1BFJxqzmXXGECD/qsn2X1nOn/Ri7lp/wzq/qZVf3MqvoRyK+OYCkjMqBgJaZUkDo+60Pp+PgyND423ATHj0q4dmGIC0ZBDKOSsiCGcWlaEMXYxC2IZGwqF0QyKrkbxPD/k+614viZW6YujON7PGw7q4N5VGWvi80G/wPmKj1lzgyCP15yGegQE+FmnhbJqTsXPPOUfK3nq5zZRrxxdHeJeHfxqWkKDJdlB5qLfBV1ahsfx0n6H26CfrpSLaLb6KRaDLZItbtcI7d79YgdbVe2bfLxvfWTNLTdCXuMVAMtuJNhqwqj+Ab3tt/DDrRdsrEjLfDEV75ti1GgvN1rH16CWQIWWLkmXBNG6sHECpI8sx2geEgjt86/3dmRPyZvRrE8l65f9LnlhWvf9jSWGUceWaqMLJjhKcvze9JiR8BtQ1dj64jvv6rp3gtW8PSH6P5FO3GSlAkyA5I5XJYDP2V/stnIpADDMmaYp34kDKhS5ix8sBMxdX8AowlvoSIrpjjWxbWder6CjDBT945MfixD22Zm081xuwRhi++OJSzLpw71xLqHkB26deVPFg0spOJ/YE88dm5LtWDC/d1o7llzGyBpOnN00pgWiBVXUhQgjE4IS5GYTgjKWoPRz+1ZgHdTlgNfgbdOtG6nDp4C/Vhzcafz+k9yJ5vWr7BHGek4x1waQJ0r2GqT0sSuaqv2Me2GXDhOuGwf2YyIyYOCqSn0LlyM8Lg9ZI3jffoaOsATaDR520CE0qyJtBZRgkfTRxcfyV9/e/WaOKyTH9swjaOP+EnlCAwysWR6+bgQP3BDXPc2wQH+uI7rmt7TokBjSPV1INdCu4Vbsbn51NsujiXASIaIyLNKlNUs53oJ2fMWqXbi6S3nhAt0A+f+XsWkfu+Z2focg6IDs31NqQWEYL+GbnC8YxnBghd2KI64ytGukdW55aNVoeEktDWJQ9f9sMX5L33OP9Ypr72ug4nELbhdgoa0Utzc2wsj74ApUPsVHlJ/ucZT2ALMUuK1rgVYHvGG1h59WYeVlw+bW1xrLImBWtXXvCqV0z26NKbUey9fspJP0lxW2UTDd1BswmXPei7sF1JvAMgU4cn+2RFFVmpOL1CwTkhtfhs5IcX6epa1VQtEE//wvl7gX2+Nu9FSBxsvVM8Fkn2MQZwuxzjrgG1a4RqTupNvTxkKxnMbPubyb5sPbd9PX09ev347eWX3XVKbglmL8jfIastt8qNtNh82pvlnXfnzojZwZ16WOeM25ts5P3gb2VxEpAnda931u8bGGqxJf6EPDzOm4Url6zW+dhfh0HQyrn03g79DNji/R+7oBfn8Bve9a4B+O0BtK0o8+f/eW3o7JNO5orgRzDX+cRnySCU9O/ce8DnZeZszyFOdPYr7NjdtLXrDWl9jYAWWYVPWlwcPsJ+mUJrW0J6v7ri5D4eX1DXXt6Nd14O079Z12Xp4cBCX8huI9brh0uB/ZHC9/helrJ7e sidebar_class_name: "get api-method" info_path: platform-api//seqera-api custom_edit_url: null diff --git a/platform-api-docs/docs/info/parameter-tables/workflows/parameters.yml b/platform-api-docs/docs/info/parameter-tables/workflows/parameters.yml index 8c58931ec..e44d381a7 100644 --- a/platform-api-docs/docs/info/parameter-tables/workflows/parameters.yml +++ b/platform-api-docs/docs/info/parameter-tables/workflows/parameters.yml @@ -2,8 +2,9 @@ Type: array Location: query Req/Opt: Optional - Description: "Additional attribute values to include in the response (`labels`, - `optimized` status). Returns an empty value (`labels: null`) if omitted." + Description: Additional attribute values to include in the response. Supported + values are `optimized`, `labels`, `messages`, `minimal`, and `pipelineInfo`. + Returns `null` for attributes omitted from the request. - Name: "`workspaceId`" Type: integer Location: query diff --git a/platform-api-docs/docs/info/workflows.info.api.mdx b/platform-api-docs/docs/info/workflows.info.api.mdx index 772b8a5f3..b8534f8e8 100644 --- a/platform-api-docs/docs/info/workflows.info.api.mdx +++ b/platform-api-docs/docs/info/workflows.info.api.mdx @@ -17,6 +17,10 @@ import MDXComponents from "@theme-original/MDXComponents"; Manage workflow executions ([pipeline runs](https://docs.seqera.io/platform-cloud/monitoring/overview)) in Seqera Platform. +The `List workflows` and `Describe workflow` endpoints support the `attributes` query parameter to enrich the default response. Current supported values are `optimized`, `labels`, `messages`, `minimal`, and `pipelineInfo`. + +Use `attributes=pipelineInfo` to include the source pipeline reference for a run, including the pipeline identifier, workspace identifier, and version metadata. + ### Path and query parameters ::table{file=parameter-tables/workflows/parameters.yml} diff --git a/platform-api-docs/docs/list-workflows.ParamsDetails.json b/platform-api-docs/docs/list-workflows.ParamsDetails.json index 7371101fe..d0f6115bc 100644 --- a/platform-api-docs/docs/list-workflows.ParamsDetails.json +++ b/platform-api-docs/docs/list-workflows.ParamsDetails.json @@ -1 +1 @@ -{"parameters":[{"name":"attributes","in":"query","description":"Additional attribute values to include in the response (`labels`, `optimized` status). Returns an empty value (`labels: null`) if omitted.","explode":false,"schema":{"type":"array","items":{"type":"string","enum":["optimized","labels","messages","minimal","pipelineVersion"],"x-enum-varnames":["optimized","labels","messages","minimal","pipelineVersion"],"title":"WorkflowQueryAttribute"}}},{"name":"workspaceId","in":"query","description":"Workspace numeric identifier","schema":{"type":"integer","format":"int64"}},{"name":"max","in":"query","description":"Pagination max results","schema":{"type":"integer","format":"int32"}},{"name":"offset","in":"query","description":"Pagination offset","schema":{"type":"integer","format":"int32"}},{"name":"search","in":"query","description":"Filter search parameter","schema":{"type":"string"}}]} +{"parameters":[{"name":"attributes","in":"query","description":"Additional attribute values to include in the response. Supported values are `optimized`, `labels`, `messages`, `minimal`, and `pipelineInfo`. Returns `null` for attributes omitted from the request.","explode":false,"schema":{"type":"array","items":{"type":"string","enum":["optimized","labels","messages","minimal","pipelineInfo"],"x-enum-varnames":["optimized","labels","messages","minimal","pipelineInfo"],"title":"WorkflowQueryAttribute"}}},{"name":"workspaceId","in":"query","description":"Workspace numeric identifier","schema":{"type":"integer","format":"int64"}},{"name":"max","in":"query","description":"Pagination max results","schema":{"type":"integer","format":"int32"}},{"name":"offset","in":"query","description":"Pagination offset","schema":{"type":"integer","format":"int32"}},{"name":"search","in":"query","description":"Filter search parameter","schema":{"type":"string"}}]} diff --git a/platform-api-docs/docs/list-workflows.StatusCodes.json b/platform-api-docs/docs/list-workflows.StatusCodes.json index 2530aff26..738a3eaaa 100644 --- a/platform-api-docs/docs/list-workflows.StatusCodes.json +++ b/platform-api-docs/docs/list-workflows.StatusCodes.json @@ -1 +1 @@ -{"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"workflows":{"type":"array","items":{"type":"object","properties":{"workflow":{"type":"object","properties":{"messages":{"type":"array","items":{"type":"string"}},"id":{"type":"string"},"ownerId":{"type":"integer","format":"int64"},"submit":{"type":"string","format":"date-time"},"start":{"type":"string","format":"date-time"},"complete":{"type":"string","format":"date-time"},"dateCreated":{"type":"string","format":"date-time"},"lastUpdated":{"type":"string","format":"date-time"},"runName":{"type":"string"},"sessionId":{"type":"string"},"profile":{"type":"string"},"workDir":{"type":"string"},"commitId":{"type":"string"},"userName":{"type":"string"},"scriptId":{"type":"string"},"revision":{"type":"string"},"commandLine":{"type":"string"},"projectName":{"type":"string"},"scriptName":{"type":"string"},"launchId":{"type":"string"},"status":{"type":"string","enum":["SUBMITTED","RUNNING","SUCCEEDED","FAILED","CANCELLED","UNKNOWN"],"title":"WorkflowStatus"},"requiresAttention":{"type":"boolean"},"configFiles":{"type":"array","items":{"type":"string"}},"params":{"type":"object","additionalProperties":true},"configText":{"type":"string"},"manifest":{"type":"object","properties":{"nextflowVersion":{"description":"Nextflow version declared by the pipeline manifest.","maxLength":20,"type":"string"},"defaultBranch":{"description":"Default source control branch declared by the manifest.","maxLength":20,"type":"string"},"version":{"description":"Pipeline version declared by the manifest.","maxLength":20,"type":"string"},"homePage":{"description":"Pipeline homepage URL declared by the manifest.","maxLength":200,"type":"string"},"gitmodules":{"description":"Comma-separated git submodule paths declared by the manifest.","maxLength":150,"type":"string"},"description":{"description":"Pipeline description declared by the manifest.","maxLength":1024,"type":"string"},"name":{"description":"Pipeline name declared by the manifest.","maxLength":150,"type":"string"},"mainScript":{"description":"Main workflow script filename declared by the manifest.","maxLength":100,"type":"string"},"author":{"description":"Pipeline author declared by the manifest.","maxLength":150,"type":"string"},"icon":{"description":"Relative path or URL for the pipeline icon.","maxLength":255,"type":"string"}},"title":"WfManifest"},"nextflow":{"type":"object","properties":{"version":{"description":"Nextflow runtime version used for the workflow run.","maxLength":20,"type":"string"},"build":{"description":"Nextflow build identifier.","maxLength":10,"type":"string"},"timestamp":{"description":"Timestamp associated with the reported Nextflow build.","type":"string","format":"date-time"}},"title":"WfNextflow"},"stats":{"type":"object","properties":{"computeTimeFmt":{"description":"Human-readable total compute time across workflow tasks.","maxLength":50,"type":"string"},"cachedCount":{"description":"Number of cached tasks.","type":"integer","format":"int32"},"failedCount":{"description":"Number of failed tasks.","type":"integer","format":"int32"},"ignoredCount":{"description":"Number of ignored tasks.","type":"integer","format":"int32"},"succeedCount":{"description":"Number of successful tasks.","type":"integer","format":"int32"},"cachedCountFmt":{"description":"Human-readable cached task count.","type":"string"},"succeedCountFmt":{"description":"Human-readable successful task count.","type":"string"},"failedCountFmt":{"description":"Human-readable failed task count.","type":"string"},"ignoredCountFmt":{"description":"Human-readable ignored task count.","type":"string"},"cachedPct":{"description":"Percentage of tasks satisfied from cache.","type":"number","format":"float"},"failedPct":{"description":"Percentage of tasks that failed.","type":"number","format":"float"},"succeedPct":{"description":"Percentage of tasks that succeeded.","type":"number","format":"float"},"ignoredPct":{"description":"Percentage of tasks that were ignored.","type":"number","format":"float"},"cachedDuration":{"description":"Aggregate duration in milliseconds for cached tasks.","type":"integer","format":"int64"},"failedDuration":{"description":"Aggregate duration in milliseconds for failed tasks.","type":"integer","format":"int64"},"succeedDuration":{"description":"Aggregate duration in milliseconds for successful tasks.","type":"integer","format":"int64"}},"title":"WfStats"},"errorMessage":{"type":"string"},"errorReport":{"type":"string"},"deleted":{"type":"boolean"},"projectDir":{"type":"string"},"homeDir":{"type":"string"},"container":{"type":"string"},"repository":{"type":"string"},"containerEngine":{"type":"string"},"scriptFile":{"type":"string"},"launchDir":{"type":"string"},"duration":{"type":"integer","format":"int64"},"exitStatus":{"type":"integer","format":"int32"},"resume":{"type":"boolean"},"success":{"type":"boolean"}},"title":"WorkflowDbDto"},"progress":{"type":"object","properties":{"workflowProgress":{"required":["aborted","cached","cpuLoad","cpuTime","cpus","failed","ignored","invCtxSwitch","loadCpus","loadMemory","loadTasks","memoryReq","memoryRss","peakCpus","peakMemory","peakTasks","pending","readBytes","retries","running","submitted","succeeded","volCtxSwitch","writeBytes"],"type":"object","properties":{"pending":{"type":"integer","format":"int64"},"submitted":{"type":"integer","format":"int64"},"running":{"type":"integer","format":"int64"},"succeeded":{"type":"integer","format":"int64"},"failed":{"type":"integer","format":"int64"},"cached":{"type":"integer","format":"int64"},"aborted":{"type":"integer","format":"int64"},"retries":{"type":"integer","format":"int64"},"ignored":{"type":"integer","format":"int64"},"memoryEfficiency":{"type":"number","format":"float"},"cpuEfficiency":{"type":"number","format":"float"},"dateCreated":{"type":"string","format":"date-time"},"lastUpdated":{"type":"string","format":"date-time"},"version":{"type":"integer","format":"int64"},"executors":{"type":"array","items":{"type":"string"}},"cpus":{"type":"integer","format":"int64"},"cpuTime":{"type":"integer","format":"int64"},"cpuLoad":{"type":"integer","format":"int64"},"memoryRss":{"type":"integer","format":"int64"},"memoryReq":{"type":"integer","format":"int64"},"readBytes":{"type":"integer","format":"int64"},"writeBytes":{"type":"integer","format":"int64"},"volCtxSwitch":{"type":"integer","format":"int64"},"invCtxSwitch":{"type":"integer","format":"int64"},"loadTasks":{"type":"integer","format":"int64"},"loadCpus":{"type":"integer","format":"int64"},"loadMemory":{"type":"integer","format":"int64"},"peakCpus":{"type":"integer","format":"int64"},"peakTasks":{"type":"integer","format":"int64"},"peakMemory":{"type":"integer","format":"int64"},"cost":{"type":"number"},"netCpus":{"type":"integer","format":"int64"},"netCpuTime":{"type":"integer","format":"int64"},"netCpuLoad":{"type":"integer","format":"int64"},"netMemoryRss":{"type":"integer","format":"int64"},"netMemoryReq":{"type":"integer","format":"int64"},"netMemoryConsumption":{"type":"number"},"netReadBytes":{"type":"integer","format":"int64"},"netWriteBytes":{"type":"integer","format":"int64"},"netVolCtxSwitch":{"type":"integer","format":"int64"},"netInvCtxSwitch":{"type":"integer","format":"int64"},"netCost":{"type":"number"}},"title":"WorkflowLoad"},"processesProgress":{"type":"array","items":{"required":["aborted","cached","cpuLoad","cpuTime","cpus","failed","ignored","invCtxSwitch","loadCpus","loadMemory","loadTasks","memoryReq","memoryRss","peakCpus","peakMemory","peakTasks","pending","process","readBytes","retries","running","submitted","succeeded","volCtxSwitch","writeBytes"],"type":"object","properties":{"pending":{"type":"integer","format":"int64"},"submitted":{"type":"integer","format":"int64"},"running":{"type":"integer","format":"int64"},"succeeded":{"type":"integer","format":"int64"},"failed":{"type":"integer","format":"int64"},"cached":{"type":"integer","format":"int64"},"aborted":{"type":"integer","format":"int64"},"retries":{"type":"integer","format":"int64"},"ignored":{"type":"integer","format":"int64"},"memoryEfficiency":{"type":"number","format":"float"},"cpuEfficiency":{"type":"number","format":"float"},"dateCreated":{"type":"string","format":"date-time"},"lastUpdated":{"type":"string","format":"date-time"},"version":{"type":"integer","format":"int64"},"process":{"type":"string"},"cpus":{"type":"integer","format":"int64","deprecated":true},"cpuTime":{"type":"integer","format":"int64","deprecated":true},"cpuLoad":{"type":"integer","format":"int64","deprecated":true},"memoryRss":{"type":"integer","format":"int64","deprecated":true},"memoryReq":{"type":"integer","format":"int64","deprecated":true},"readBytes":{"type":"integer","format":"int64","deprecated":true},"writeBytes":{"type":"integer","format":"int64","deprecated":true},"volCtxSwitch":{"type":"integer","format":"int64","deprecated":true},"invCtxSwitch":{"type":"integer","format":"int64","deprecated":true},"loadTasks":{"type":"integer","format":"int64","deprecated":true},"loadCpus":{"type":"integer","format":"int64"},"loadMemory":{"type":"integer","format":"int64"},"peakCpus":{"type":"integer","format":"int64"},"peakTasks":{"type":"integer","format":"int64"},"peakMemory":{"type":"integer","format":"int64"}},"title":"ProcessLoad"}},"totalProcesses":{"type":"integer","format":"int32"}},"title":"ProgressData"},"orgId":{"type":"integer","format":"int64"},"orgName":{"type":"string"},"workspaceId":{"type":"integer","format":"int64"},"workspaceName":{"type":"string"},"labels":{"type":"array","items":{"type":"object","properties":{"id":{"type":"integer","format":"int64","description":"Label numeric identifier."},"name":{"type":"string","description":"Label key name."},"value":{"type":"string","description":"Label value."},"resource":{"type":"boolean","description":"Whether this is a resource label (applied to workflow tasks for compute resource allocation)."},"isDefault":{"type":"boolean","description":"Whether this label is automatically applied to new resources by default."},"isDynamic":{"type":"boolean","description":"Whether this label's value can be dynamically computed from workflow metadata."},"isInterpolated":{"type":"boolean","description":"Whether this label contains interpolated variables resolved at runtime."},"dateCreated":{"type":"string","format":"date-time","description":"Timestamp when the label was created."}},"description":"Label object for categorizing and organizing resources (workflows, pipelines, compute environments, actions, datasets).","title":"LabelDbDto"}},"starred":{"type":"boolean"},"optimized":{"type":"boolean"}},"title":"ListWorkflowsResponse.ListWorkflowsElement"}},"totalSize":{"type":"integer","format":"int64"}},"title":"ListWorkflowsResponse"}}}},"400":{"description":"Bad request","content":{"application/json":{"schema":{"required":["message"],"type":"object","properties":{"message":{"type":"string"}},"title":"ErrorResponse"}}}},"403":{"description":"Operation not allowed"}}} +{"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"workflows":{"type":"array","items":{"type":"object","properties":{"workflow":{"type":"object","properties":{"messages":{"type":"array","items":{"type":"string"}},"id":{"type":"string"},"ownerId":{"type":"integer","format":"int64"},"submit":{"type":"string","format":"date-time"},"start":{"type":"string","format":"date-time"},"complete":{"type":"string","format":"date-time"},"dateCreated":{"type":"string","format":"date-time"},"lastUpdated":{"type":"string","format":"date-time"},"runName":{"type":"string"},"sessionId":{"type":"string"},"profile":{"type":"string"},"workDir":{"type":"string"},"commitId":{"type":"string"},"userName":{"type":"string"},"scriptId":{"type":"string"},"revision":{"type":"string"},"commandLine":{"type":"string"},"projectName":{"type":"string"},"scriptName":{"type":"string"},"launchId":{"type":"string"},"status":{"type":"string","enum":["SUBMITTED","RUNNING","SUCCEEDED","FAILED","CANCELLED","UNKNOWN"],"title":"WorkflowStatus"},"requiresAttention":{"type":"boolean"},"configFiles":{"type":"array","items":{"type":"string"}},"params":{"type":"object","additionalProperties":true},"configText":{"type":"string"},"manifest":{"type":"object","properties":{"nextflowVersion":{"description":"Nextflow version declared by the pipeline manifest.","maxLength":20,"type":"string"},"defaultBranch":{"description":"Default source control branch declared by the manifest.","maxLength":20,"type":"string"},"version":{"description":"Pipeline version declared by the manifest.","maxLength":20,"type":"string"},"homePage":{"description":"Pipeline homepage URL declared by the manifest.","maxLength":200,"type":"string"},"gitmodules":{"description":"Comma-separated git submodule paths declared by the manifest.","maxLength":150,"type":"string"},"description":{"description":"Pipeline description declared by the manifest.","maxLength":1024,"type":"string"},"name":{"description":"Pipeline name declared by the manifest.","maxLength":150,"type":"string"},"mainScript":{"description":"Main workflow script filename declared by the manifest.","maxLength":100,"type":"string"},"author":{"description":"Pipeline author declared by the manifest.","maxLength":150,"type":"string"},"icon":{"description":"Relative path or URL for the pipeline icon.","maxLength":255,"type":"string"}},"title":"WfManifest"},"nextflow":{"type":"object","properties":{"version":{"description":"Nextflow runtime version used for the workflow run.","maxLength":20,"type":"string"},"build":{"description":"Nextflow build identifier.","maxLength":10,"type":"string"},"timestamp":{"description":"Timestamp associated with the reported Nextflow build.","type":"string","format":"date-time"}},"title":"WfNextflow"},"stats":{"type":"object","properties":{"computeTimeFmt":{"description":"Human-readable total compute time across workflow tasks.","maxLength":50,"type":"string"},"cachedCount":{"description":"Number of cached tasks.","type":"integer","format":"int32"},"failedCount":{"description":"Number of failed tasks.","type":"integer","format":"int32"},"ignoredCount":{"description":"Number of ignored tasks.","type":"integer","format":"int32"},"succeedCount":{"description":"Number of successful tasks.","type":"integer","format":"int32"},"cachedCountFmt":{"description":"Human-readable cached task count.","type":"string"},"succeedCountFmt":{"description":"Human-readable successful task count.","type":"string"},"failedCountFmt":{"description":"Human-readable failed task count.","type":"string"},"ignoredCountFmt":{"description":"Human-readable ignored task count.","type":"string"},"cachedPct":{"description":"Percentage of tasks satisfied from cache.","type":"number","format":"float"},"failedPct":{"description":"Percentage of tasks that failed.","type":"number","format":"float"},"succeedPct":{"description":"Percentage of tasks that succeeded.","type":"number","format":"float"},"ignoredPct":{"description":"Percentage of tasks that were ignored.","type":"number","format":"float"},"cachedDuration":{"description":"Aggregate duration in milliseconds for cached tasks.","type":"integer","format":"int64"},"failedDuration":{"description":"Aggregate duration in milliseconds for failed tasks.","type":"integer","format":"int64"},"succeedDuration":{"description":"Aggregate duration in milliseconds for successful tasks.","type":"integer","format":"int64"}},"title":"WfStats"},"errorMessage":{"type":"string"},"errorReport":{"type":"string"},"deleted":{"type":"boolean"},"projectDir":{"type":"string"},"homeDir":{"type":"string"},"container":{"type":"string"},"repository":{"type":"string"},"containerEngine":{"type":"string"},"scriptFile":{"type":"string"},"launchDir":{"type":"string"},"duration":{"type":"integer","format":"int64"},"exitStatus":{"type":"integer","format":"int32"},"resume":{"type":"boolean"},"success":{"type":"boolean"}},"title":"WorkflowDbDto"},"progress":{"type":"object","properties":{"workflowProgress":{"required":["aborted","cached","cpuLoad","cpuTime","cpus","failed","ignored","invCtxSwitch","loadCpus","loadMemory","loadTasks","memoryReq","memoryRss","peakCpus","peakMemory","peakTasks","pending","readBytes","retries","running","submitted","succeeded","volCtxSwitch","writeBytes"],"type":"object","properties":{"pending":{"type":"integer","format":"int64"},"submitted":{"type":"integer","format":"int64"},"running":{"type":"integer","format":"int64"},"succeeded":{"type":"integer","format":"int64"},"failed":{"type":"integer","format":"int64"},"cached":{"type":"integer","format":"int64"},"aborted":{"type":"integer","format":"int64"},"retries":{"type":"integer","format":"int64"},"ignored":{"type":"integer","format":"int64"},"memoryEfficiency":{"type":"number","format":"float"},"cpuEfficiency":{"type":"number","format":"float"},"dateCreated":{"type":"string","format":"date-time"},"lastUpdated":{"type":"string","format":"date-time"},"version":{"type":"integer","format":"int64"},"executors":{"type":"array","items":{"type":"string"}},"cpus":{"type":"integer","format":"int64"},"cpuTime":{"type":"integer","format":"int64"},"cpuLoad":{"type":"integer","format":"int64"},"memoryRss":{"type":"integer","format":"int64"},"memoryReq":{"type":"integer","format":"int64"},"readBytes":{"type":"integer","format":"int64"},"writeBytes":{"type":"integer","format":"int64"},"volCtxSwitch":{"type":"integer","format":"int64"},"invCtxSwitch":{"type":"integer","format":"int64"},"loadTasks":{"type":"integer","format":"int64"},"loadCpus":{"type":"integer","format":"int64"},"loadMemory":{"type":"integer","format":"int64"},"peakCpus":{"type":"integer","format":"int64"},"peakTasks":{"type":"integer","format":"int64"},"peakMemory":{"type":"integer","format":"int64"},"cost":{"type":"number"},"netCpus":{"type":"integer","format":"int64"},"netCpuTime":{"type":"integer","format":"int64"},"netCpuLoad":{"type":"integer","format":"int64"},"netMemoryRss":{"type":"integer","format":"int64"},"netMemoryReq":{"type":"integer","format":"int64"},"netMemoryConsumption":{"type":"number"},"netReadBytes":{"type":"integer","format":"int64"},"netWriteBytes":{"type":"integer","format":"int64"},"netVolCtxSwitch":{"type":"integer","format":"int64"},"netInvCtxSwitch":{"type":"integer","format":"int64"},"netCost":{"type":"number"}},"title":"WorkflowLoad"},"processesProgress":{"type":"array","items":{"required":["aborted","cached","cpuLoad","cpuTime","cpus","failed","ignored","invCtxSwitch","loadCpus","loadMemory","loadTasks","memoryReq","memoryRss","peakCpus","peakMemory","peakTasks","pending","process","readBytes","retries","running","submitted","succeeded","volCtxSwitch","writeBytes"],"type":"object","properties":{"pending":{"type":"integer","format":"int64"},"submitted":{"type":"integer","format":"int64"},"running":{"type":"integer","format":"int64"},"succeeded":{"type":"integer","format":"int64"},"failed":{"type":"integer","format":"int64"},"cached":{"type":"integer","format":"int64"},"aborted":{"type":"integer","format":"int64"},"retries":{"type":"integer","format":"int64"},"ignored":{"type":"integer","format":"int64"},"memoryEfficiency":{"type":"number","format":"float"},"cpuEfficiency":{"type":"number","format":"float"},"dateCreated":{"type":"string","format":"date-time"},"lastUpdated":{"type":"string","format":"date-time"},"version":{"type":"integer","format":"int64"},"process":{"type":"string"},"cpus":{"type":"integer","format":"int64","deprecated":true},"cpuTime":{"type":"integer","format":"int64","deprecated":true},"cpuLoad":{"type":"integer","format":"int64","deprecated":true},"memoryRss":{"type":"integer","format":"int64","deprecated":true},"memoryReq":{"type":"integer","format":"int64","deprecated":true},"readBytes":{"type":"integer","format":"int64","deprecated":true},"writeBytes":{"type":"integer","format":"int64","deprecated":true},"volCtxSwitch":{"type":"integer","format":"int64","deprecated":true},"invCtxSwitch":{"type":"integer","format":"int64","deprecated":true},"loadTasks":{"type":"integer","format":"int64","deprecated":true},"loadCpus":{"type":"integer","format":"int64"},"loadMemory":{"type":"integer","format":"int64"},"peakCpus":{"type":"integer","format":"int64"},"peakTasks":{"type":"integer","format":"int64"},"peakMemory":{"type":"integer","format":"int64"}},"title":"ProcessLoad"}},"totalProcesses":{"type":"integer","format":"int32"}},"title":"ProgressData"},"orgId":{"type":"integer","format":"int64"},"orgName":{"type":"string"},"workspaceId":{"type":"integer","format":"int64"},"workspaceName":{"type":"string"},"labels":{"type":"array","items":{"type":"object","properties":{"id":{"type":"integer","format":"int64","description":"Label numeric identifier."},"name":{"type":"string","description":"Label key name."},"value":{"type":"string","description":"Label value."},"resource":{"type":"boolean","description":"Whether this is a resource label (applied to workflow tasks for compute resource allocation)."},"isDefault":{"type":"boolean","description":"Whether this label is automatically applied to new resources by default."},"isDynamic":{"type":"boolean","description":"Whether this label's value can be dynamically computed from workflow metadata."},"isInterpolated":{"type":"boolean","description":"Whether this label contains interpolated variables resolved at runtime."},"dateCreated":{"type":"string","format":"date-time","description":"Timestamp when the label was created."}},"description":"Label object for categorizing and organizing resources (workflows, pipelines, compute environments, actions, datasets).","title":"LabelDbDto"}},"starred":{"type":"boolean"},"optimized":{"type":"boolean"},"pipelineInfo":{"type":"object","properties":{"id":{"type":"integer","format":"int64","description":"Pipeline numeric identifier."},"workspaceId":{"type":"integer","format":"int64","description":"Workspace numeric identifier where the pipeline is located."},"version":{"description":"Pipeline version information.","type":"object","properties":{"id":{"type":"string","description":"Pipeline version string identifier."},"name":{"type":"string","description":"Pipeline version name."},"dateCreated":{"type":"string","format":"date-time","description":"Date and time the version was created, in ISO 8601 format."},"lastUpdated":{"type":"string","format":"date-time","description":"Date and time the version was last updated, in ISO 8601 format."},"hash":{"type":"string","description":"Git commit hash for this version."},"isDefault":{"type":"boolean","description":"Whether this version is the default version."},"isDraftVersion":{"type":"boolean","description":"Whether this version is a draft (unpublished) version."}},"title":"PipelineMinInfoResponse.PipelineVersionMinInfoResponse"}},"title":"PipelineMinInfoResponse"}},"title":"ListWorkflowsResponse.ListWorkflowsElement"}},"totalSize":{"type":"integer","format":"int64"},"hasMore":{"type":"boolean"}},"title":"ListWorkflowsResponse"}}}},"400":{"description":"Bad request","content":{"application/json":{"schema":{"required":["message"],"type":"object","properties":{"message":{"type":"string"}},"title":"ErrorResponse"}}}},"403":{"description":"Operation not allowed"}}} diff --git a/platform-api-docs/docs/list-workflows.api.mdx b/platform-api-docs/docs/list-workflows.api.mdx index 7f30967b5..8d37396a4 100644 --- a/platform-api-docs/docs/list-workflows.api.mdx +++ b/platform-api-docs/docs/list-workflows.api.mdx @@ -5,7 +5,7 @@ description: "Lists all workflow records, enriched with `attributes`. Append `?w sidebar_label: "List workflows" hide_title: true hide_table_of_contents: true -api: eJztG11z27jxr2Dw0ssMo3zcpQ9+aR3buXrO8bn+uDxkPGOIXEm4gAADLP1xHv33zgIgRUmkBCYzbae9J1HEfmF3sdgFls8cxdzxg8/8wdgvM2UeHL/NeAEut7JCaTQ/4GfSoWNCKdYAMQu5sYXLGGgr8wUU7EHigt0JRCunNYK7m7DDqgJdsLu/EZqrRA6nxR1Dw5R0uEWLSc0Ea0FZbjTCI054xk0FVpAwp0UU51MrbcYrYUUJCJbm8cy1KIEf8JUkPOOSpvG1BvvENyd3WBSSHoViLQq7F6oGR6JKnau6ABIOF8AsuMpoB+yHOyWmoNxdxu5MhbKUf0BxxxwKrN2LCbsErK12TGgGZYVPgWSLdsB0rdTdCyZnzJQSEQqaKDxWyhTAD2ZCOci4yxdQCn7wzPGp8rOyVtAcJELpOu8dWqnnREHXJZmzlYlnPLDkGS/BOTH3GimllqVQpD5ZgZIafgPrSCW3GX98SWRe3gtLynTfTQ8lKpKysdo/yRKHjbb5crnMWrt1fGW34T61nqLrEqzMmSxAo5xJsLxHdVIjzP3QzNhSYHj11594l3spHndzvRBzqb0vslI8kj/UCl06vx/frvEzs5kDTGbZgn8bNwfC5ovd3D5IhWBZAGXt2urjGZ1uubzNeLMwvFO+ff2aftYJ//oLz7hf1BppVFSVkrmf16vfHYE8b7Mw098hpwlXloIAysBgFaz2L409JPZDtl6evAyXy4zLoud9xs2DBntaJPllxl09LSX2rfMWthAIL1GW4OFR2BHguSkrBQjpGPTnyIJA6JneEJISDm+qYhySrfW599oeJTpwLu4GPaOVNTOp+jHJ6sfS9o7lpiwlDhCtHdhhebybD2BauJc+EA7xFLo4k7qfcmUN+eQezoPDStQ6XwwIFvaqXZvI1c37j6fX1yfHPOOXN+fnp+c/84xf3RwdnZwc+7cfDk/P/MPR4fnRyVl4vjn/5fzXT+d9kf8q8PRq+VpLC+4QKSCs62dqjAKhg4L0TM4/SDV2/fnI1RsHRLvjX3TWOdoaWn7X8NizjJYZL4WWM3C4P2poeESacbMNbsXD8wjA7gMEKyBXwkLBpk8+12g2UtYwpQyhFI9noOe44AdvX2fbAhYwE7XC91bofLHN9DgMM2dqG3MsaxSbevAtCcYwvh+a50UzjaF5juGyMCVciDnsYEMglZgDu7k8S+fVx2wusTRFHV1vnd0RLdyXDsjNEAo2l8goWnt4VglcuFTmb971G7LDbnCyndfJ7F6//amHn44xZIARDX/fhEoh9ZUnvc3mo5B6VRCEEUZBfBTbXiOKGhfG7phZAPi+ucm8z0qXoATK++AOzFjvkTNj11c34W6647t3W0yWnWA6+9iEITJcjCP7Q9LgEm1Dka017b/tUq0dFK3Eq4Kt3hK4TynTWqpiBzM/3knat8zZQ5OkcyjKapvudTPEhHMml35Z+qo0FG6VsfRmnT3xTMlH1rTfkGg20YRskzKtGoFk/FD2LIB/1KXQLy2IQkwVMDQoFItIzJtE5NY4tzICCvfFbais1zdzQfX5kal1D9/zupyCZWbGAtiK7N66IuMzIVUC5QA2irKca2MTSEe4UbRdneeQQNvDOTer1SjyHXWnWLqjdpYT0rZHbsicQnVD9h2UOzZMIdyx5Q6iXfOlUO2acQfZoKuLvIfgBdgcNNK2b2bBXswJlG4mKYJZUwZNd+hqb+muDWfKCFwpJZkRLgRGzaTRj+YcxyAipfKIOh3H4wFsa400NsEmx3U4n9tmdTifW5gLBFZEGDpKK6VS0kFudOH8/jIq+oTaOCj8uzmPik5NVe4t8d2sR0eYcFjV2Ymu/O6zzDhYa+zHcFDRW7h4gEu/CfaOF0AHAd1CsVOExSp0qHCmjHu4qNYopIb+UdqVnURjn3Yjn+j5UIUc9P5hqOAPFfCQdEXHhAmGh0eJV5tV867NgI4H10rzjlKj9fsGl9uF8/H0GE20xdyu4+054broYMSqu6DqXkx9RsSbRUwPVX1mRHyiZCU80flmWCe8DSz+FPH+CB+vHiT6Q0VlRHEUgOnxI5TGny/Sn2vyb39iTC8v4evq2fkzfBBfIi49trj0p8Gly4SQodHG8f4pHO1bQCvDU611GA/HZmFubdjkGb83qivwg5UIgc5ttkeZDfMx53br62kXfCN6KvVmSmnw0XRpwNEX0oAbF0qcZTRVGnTjZ2nQwZlOZjOZS9B5N57s2r2qeizKv+8EtFOuJcUmyGs0duQxmV/diZ4RQ0IytA8lY8x36VJlWcWRVNdrIkYafCc0pCGshZZEB++GzzSUVShNhz9Kt3AnbKchtGE7HXyM+J2tINHpzNrRbFzG/pAER8gZoEc4e0AY4e8a8ONIl1+hJHt9i3JktKvLaiPVWVPP5cgVogE/jV0kGvC38etEA56OXypkkn5v6MmuvOVCckU5GbiL7SxrK5j+b+RSccp/ZlV/ZlV/ZlXbO1BcHb3VaeKGQsV1ZSEPcjb3jOn7yxB+6nbTiz8q4dpFIW0z6qUwKinrpTAuTeslMTZx6yUyNpXrJTIquRuk8P+T7nX28YuwTMM2Tu/p/uSi2cyTDmvWqfnN/1ig8D07dp7csWPsfLAbo9valliGNBg7Ojx8L943t0HJ5BCy1hFKXHv67ibdm+TNeNxH4gs8+atlj+hbJFMxPfAkHrL5boaek7StnsEF4ALoOlM6Jh0TrEFmXpHsB9+VRufBZuOqLRxTxxu5FksoZUIP2wsvi3Sxw2KsMIE9iVSjKQXKXCj1xDriaHho+Tq6pY6tHg3fJy1KmX8T37+42J6aC82mwIpAy0sQpxwvUVqdlICiECgi91ONYCujRP8ZcsLU41kvtQGvSLF7YSVdETk/dXUPBRPYXFNPvi1z2BRmdXH8sIDQ5htEehCO5YH0xAeIPj8M6ypeYiDMjZV/SD1nQhfM2LnQ4e/Kcj+0zYtZ2wTgsta1QN9La3QJGl3GRE7MXMZI1w7QvfCXBDFQeQniyXDs/rNDZ/irBt7dB85r3dWXsatzsvb2RAGJt4q0V/KPtEp5Hx9qBV5m/Ke+/tH3omBUclHbw4hG0m6VFjs599cl5eBNSmcGJ+FKZUPyH7cl/7VpX2faoA8ZDxD2KQd5bSU++cb19yAs2MOabvI/31JTbQm4MNTyPvdNv9RGwg/4q7Z1lQjY+6bxvbaKH/AFYuUOXr0SlZzkytTFxMFXsGIizZbnX/kRdqEEkqXYEcGzw4tTTtwb4a5Il0EvXRFb1RDHpj3Ye5UH4ll8+ND4wO8PwWWknhmPHvUYpSC2+wSk6UpaRAHYx4xwwbk++e6UoRRSeRecmb+vBrqlAH8zefPm3eS1T0KMw1J4J4pd02fdrxXcpozPK1f8z38oES1Cf19VSki/8r1qnqP3rD70oFWw8Cckn/nz81Q4uLFquaTXoTOcfKqQjsJv0X6RMDj3/6rvKHr18AWeNr8LiRkH59Qknz7XPZ8e7OC+/nXDN7If/AZhB+PwYcP3M2y/QNjBq4X5RnbDnyDsYNp+27Biekt/Qv7gI2rGFyAKuor+/ByxDvMcqq6oW5vJWhz++eSah5bC7i66Hu889SYZ108d2s/PAeLafAG9XPJGdKT/fHm7XC7/Bdz6ePo= +api: eJztW19v2zgS/yoEX64FVDfttotFXu5SJ+kFm6S+/GkfigChpbHNliJVknKSBv7uhyEpWbYlm0pwd8BenyxLw/kNZ4bDITl8pJZNDd3/Su+U/j4R6s7Qm4RmYFLNC8uVpPv0lBtrCBOCVEREQ6p0ZhICUvN0Bhm543ZGbpm1mo9LC+Z2QA6KAmRGbv+OzUzBUjjJbolVRHBjN3gRLgkjNSlJlbRwbwc0oaoAzVCYkyyI86WWNqEF0ywHCxr78Ugly4Hu06UkNKEcu/GjBP1A1zt3kGUcH5kgdRMyZ6IEg6JymYoyAxTOzoBoMIWSBgbksiwKpS1kFTHTQG5VYXnOf0J2m5BbwcYgDD7lYAybgn/mkudM3CaEoXIKXoDgEk7kRN0OyAXYUktDbmUpxC2ZKL0UyxCVc4uQE63yIM+PEoxTEtwXQmVA9ydMGEioSWeQM7r/SO1D4TSiNcP+cwu5abw3VnM5RQ6yzNEV6k7QhPo+0IRWXcBH3wNUfUN49Jv7V8jj1ZxptIJ5HjPLrUD5Klv/C+13UCmDLhaLpLZ2w8O2m/tL7V+yzEHzlPAMpOUTDpq2KI1LC1P3aaJ0zqx/9fs72kTP2f121BGbcuk8mOTsHr2oFNbE4/32dgVPTSYGbDRkTf40NANMp7PtaMdcWNDEk5J6RLZhBndbLG4SWg0n545v9/bwZ5Xxpz9pQl0okBa/sqIQPHX9ev3NIMnjJoQaf4MUO1xoDB2We4BliNs9KHaw2E1Zu3j0AFwsEsqzlvcJVXcS9EkW5ZcJNeU457ZthNe0GbPwyvIcHL1lugd5qvJCgIX4FvhnqIFZaOleVyPBjL0usn6NdCnPnde2KNGAMWEOaflaaDXhor0lWv2Q69ZvqcpzbjuYlgZ0tzzOzTtaaphzw71/t2IymZ1y2c650Ap9cgdy52fBSpnOOgQzltly6/Rxef3h7OTq6uiQJvTi+vz85PwjTejl9XB4dHTo3h4fnJy6h+HB+fDo1D9fn/95/unLeVvkv/SYTi0/Sq7BHFgMCKv6GSslgEmvIDnh02Mu+o4/F7la4wCr84RRY5xbXUKNdwX3LcNokdCcST4BY3dHDQn3Fnv8GXRl/dV4eB4IyNxTkAxSwTRkZPzgMoJqFiUVKOYGObs/BTm1M7r/di/ZFDCDCSuF/aCZTGeboIf+MzGq1CEz00qQsSPfkKAP8Lyrn6OqG1397IMyUzmM2BS2wCBJwaZAri9O47HawKbc5iorg+utwg1x4L4ygG6GedyUW4LR2tGTgtmZiQV/877dkA24zs42XkfD7b1914InQwzpAMLPz+tQzri8dKw3Yc4Yl8tlhP9CMIj3gm01IivtTOktPfMEz+sbT9usdAGCWT737kCUdh6J64CV0Y1t193x/fsNkEUjmE7OqjCEhgtxZHdI6hyidSjSpcT5tx6qpcElSpB4ucwrNwRuU8q45CLbAua+N5L2DXO28ETpjGV5scn3qvpEmDEq5W5YurWsX16FNd4qPGLG5CMr2q9YVJNoRLaJmVZpAWU8zlsGwD/LnMlXGljGxgKIVZYJEhoRZxKWamXM0giWme9mTWWtvpkyXNUPVSlbcM/LfAyaqAnxZEu2O9cVCZ0wLiI4e7JenPlUKh3BOtD14m3KNIUI3o7OmEkperFvqDvG0g21kxQbbXrkmswxXNdk38K5YcMYxg1bbmHaNF8M16YZt7D1uhqlLQxHoFOQFqd9NfH2IoZZbia82mRxrRt8pbN004YToZhdKiUayM6YDZqJ4x/M2Q8gNIrFCDrth3EHurZGHIy3yWHpd/U2oQ6mUw1TZoFkgQY34HIuBDeQKpkZN7/0ij5+bewV/mzkXtGpWpU7SzwbuneE8ZtVjZno0s0+i4SC1kqf+Y2K1oWLI7hwk2Dr9wxwI6C5UGwswsIqtGvhjBl396JaWsYltH/FWdlwq/TD9sZHctq1QvZ6P+5a8PsVcJd0WcOEEYaHe24v11fN2yYD3B5cWZo3lBqs3/ZxsblwPhwfWhVsMdWr7XbscI0aLcKqO8PVPRu7jIhWgxgfivJUsfCEyYp/wv1NP05oHVjcLuJ8aO8v77h1m4pCsWzoifHxDHLl9hfxzxX6t9suxpcX8GP5bNzOP7DvoS0+1m3xT9UWjyB8hoYTx4cHfyCgwWrun0op/Xe/beb7VodNmtC5Ek2B7zS34PncJDuUWYH32bdbHU/b6CvRY7lXXYqjD6aLIw6+EEdcuVBkL4Op4qgrP4uj9s50NJnwlINMm/Fk2+xVlH2b/Pd2QBvLtajYBGlple65TeZGd6RnhJAQTe1CSR/zXZhYWZZxJNb1qogRR98IDXENVkJLpIM3w2dck2Uojacfxlu4EbbjGtRhO568j/iNqSDS6dTK1mwYxm6TxPaQ01P3cHbfoIe/S7BnPV1+2STa6+smQyVNmRdrqc6Kei56jhAJ9kvfQSLBfu4/TiTYk/5DBU3S7g0t2ZWznE+uMCcDM9rMsjaC6V8jlwpd/pVV/cqqfmVVmzNQGB2tq9PICQUX14WG1MtZnTPGzy9d7WOnm9b2vRKubRziJqNWDr2SslYO/dK0VhZ9E7dWJn1TuVYmvZK7Tg7/P+leYx4f+WHqp3F8j+cno2oyj9qsWeXmJv9DZpmr2dHT6Iodpaed1RjN0rbIZUjVYkuFhyvEe3IZFI8OISt1pIjaUnc3aJ4kr8fjNhbf4cEdLbuGrvwytqUjHoRNNlfN0LKTtlEzOAM7AzzO5IZwQxipGhOnSPLCVaXhfrBaO2rz29ThRK5uxYRQvobtpZOFm1Bh0VcYD48ilVblzPKUCfFAGuJIuKtxDZ5Sh1KPCvdBspynT8L9m/HqJCmTZAwk87ycBKHL4RCl1kkOlmXMsoB+Ii3oQgnWvocc0fWw14vFw0tWZM40xyMi47ou5pARZqtj6sHTMod1YZYHx3cz8MXBXqQ7ZkjqWQ9cgGjzQz+uwiGGhanS/CeXU1cSrPSUSf93abkXdfFiUhcBmKR2LZBzrpXMQVqTEJYimEkI6tqANS/dIUEIVE6CsDMcqv901x7+snq3fYu/WbL7H4oay2KS9sDRMz72KQhG02pYK7wwxA1eZ90+BUxcekm4L9zooaqOiLaB4OmeFlg3mNXx9flD5RDPtNCzXUkCarMCaYyVBA+7Ti4/kT9+33tDPNfB0/L1fvjIn5QeoFOIGTOz3Ur8yC3x9aAEG4QaGG4qvOcF+9qRjOtDCOTrvDWb2M8bq5W+AIxkyIi8KGVRjgU3M8heNqCaeU/wnDMuMQxcVDckqvdBmLXPMSxWaFZufdQgK2+PBGAAXOZyl/xn7F7cjJkzpVsP3XYJgTcRFgl911a+/oFl1R2NPnXszU2iUEi+e1sk7zzIbfTgyJ/orkn+26bkn6o7N0Qq6zKWO/BpsoG01Nw+uNs2H4Bp0AclFhJ9vcGa/hzsTOE9nam7c4BVbHSfvq4r55GBnle3dUot6D6dWVuY/devWcEHqVBlNjDwAzQbcLXhspfuCxkJZtGMZIj05GB0QhG9Eu4Sden10hSxVg0iVrcTnLUdEU3Cw3HlIN/uvD/xaoYLegxSIOwuAbG7HOdwT+xSFl9fsdr5ZpchZ1w4/5yofyw/NCcc+mbw5s37wZ6bh5WxOXNOFC5tnDavWJl1GR+Xrvi/v90VLIJ/XxeCcZdZONU8Bu9Z3k7DUTBzG7Rf6ePjmBm41mKxwNf+Ygr6VMYNZn9ZfRWqs+9/mctfrTr8Dg/rF+HCYolSvN8Tr6cdt6a2oK9ezHoifOf1qS3A/k7W8wHry1NbsGqaJ8J1357aAlpfy1qC3uAfv/Rx0TihM2AZVtF8fQytDtIUiqaoGxPRSgz/eHRFfTV0c2ZcjZWOe7WPIB8avB8fPcWV+g5ysaCV6Bb/08XNYrH4N5/SORw= sidebar_class_name: "get api-method" info_path: platform-api//seqera-api custom_edit_url: null diff --git a/platform-api-docs/scripts/specs/seqera-api-latest-decorated.yml b/platform-api-docs/scripts/specs/seqera-api-latest-decorated.yml index f58bd0945..fcb2e80a6 100644 --- a/platform-api-docs/scripts/specs/seqera-api-latest-decorated.yml +++ b/platform-api-docs/scripts/specs/seqera-api-latest-decorated.yml @@ -7273,8 +7273,9 @@ paths: parameters: - name: attributes in: query - description: 'Additional attribute values to include in the response (`labels`, - `optimized` status). Returns an empty value (`labels: null`) if omitted.' + description: Additional attribute values to include in the response. Supported + values are `optimized`, `labels`, `messages`, `minimal`, and `pipelineInfo`. + Returns `null` for attributes omitted from the request. explode: false schema: type: array @@ -7584,8 +7585,9 @@ paths: format: int64 - name: attributes in: query - description: Comma-separated list of attributes to retrieve. Returns an empty - value for each attribute not specified. + description: Comma-separated list of attributes to retrieve. Supported values + are `optimized`, `labels`, `messages`, `minimal`, and `pipelineInfo`. + Returns `null` for each attribute not specified. explode: false schema: type: array @@ -12199,7 +12201,7 @@ components: type: object properties: workflow: - $ref: '#/components/schemas/Workflow' + $ref: '#/components/schemas/WorkflowMaxDbDto' progress: $ref: '#/components/schemas/ProgressData' platform: @@ -12226,6 +12228,8 @@ components: type: array items: type: string + pipelineInfo: + $ref: '#/components/schemas/PipelineMinInfoResponse' DescribeWorkspaceResponse: type: object properties: @@ -13498,6 +13502,8 @@ components: totalSize: type: integer format: int64 + hasMore: + type: boolean ListWorkflowsResponse.ListWorkflowsElement: type: object properties: @@ -13523,6 +13529,8 @@ components: type: boolean optimized: type: boolean + pipelineInfo: + $ref: '#/components/schemas/PipelineMinInfoResponse' ListWorkspacesAndOrgResponse: type: object properties: @@ -16243,13 +16251,13 @@ components: - labels - messages - minimal - - pipelineVersion + - pipelineInfo x-enum-varnames: - optimized - labels - messages - minimal - - pipelineVersion + - pipelineInfo WorkflowStatus: type: string enum: From 07d71ada368509d427d7ce2273e22667da08bcb2 Mon Sep 17 00:00:00 2001 From: Llewellyn vd Berg <113503285+llewellyn-sl@users.noreply.github.com> Date: Fri, 13 Mar 2026 13:21:20 +0200 Subject: [PATCH 2/2] docs: restore limited API example languages --- docusaurus.config.js | 38 ++++++++++++++++++++++++++++++++++++++ 1 file changed, 38 insertions(+) diff --git a/docusaurus.config.js b/docusaurus.config.js index aedcb2ea8..5edd2d30f 100644 --- a/docusaurus.config.js +++ b/docusaurus.config.js @@ -312,6 +312,44 @@ export default async function createConfigAsync() { contextualSearch: false, placeholder: 'Search Seqera docs...', }, + languageTabs: [ + { + highlight: "python", + language: "python", + logoClass: "python", + }, + { + highlight: "bash", + language: "curl", + logoClass: "curl", + }, + { + highlight: "java", + language: "java", + logoClass: "java", + variant: "unirest", + }, + { + highlight: "r", + language: "r", + logoClass: "r", + }, + { + highlight: "javascript", + language: "javascript", + logoClass: "javascript", + }, + { + highlight: "go", + language: "go", + logoClass: "go", + }, + { + highlight: "powershell", + language: "powershell", + logoClass: "powershell", + }, + ], prism: { additionalLanguages: [ "bash",