pipelines¶
Upload, list, update, clone, and delete pipelines; lock a draft into a versioned pipeline; and read a pipeline's source, task graph, and tasks.
List pipelines¶
Operation path: GET /api/v2/pipelines
List all pipelines accessible to the authenticated user.
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| mode | query | any | false | none |
| search | query | any | false | none |
| offset | query | integer | false | none |
| limit | query | integer | false | none |
Example responses¶
200 Response
{
"properties": {
"count": {
"readOnly": true,
"title": "Count",
"type": "integer"
},
"data": {
"items": {
"description": "Single item in a pipeline list response. ``name`` is the pipeline's display label: the user-supplied value when one was provided on upload, or the title-cased ``@pipeline`` function name otherwise. ``total_runs`` is the total number of dispatches across all versions. ``schedule`` is the most recently created active schedule for the pipeline, or ``none`` when no active schedule exists.",
"properties": {
"createdAt": {
"format": "date-time",
"title": "Createdat",
"type": "string"
},
"description": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Description"
},
"id": {
"maxLength": 24,
"minLength": 24,
"pattern": "^[0-9a-fA-F]{24}$",
"title": "Id",
"type": "string"
},
"isActive": {
"title": "Isactive",
"type": "boolean"
},
"latestVersion": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "Latestversion"
},
"mode": {
"description": "Pipeline lifecycle mode.",
"enum": [
"draft",
"locked"
],
"title": "PipelineMode",
"type": "string"
},
"name": {
"title": "Name",
"type": "string"
},
"schedule": {
"anyOf": [
{
"description": "Active schedule summary surfaced on the pipeline list.",
"properties": {
"cronExpression": {
"title": "Cronexpression",
"type": "string"
},
"timezone": {
"title": "Timezone",
"type": "string"
}
},
"required": [
"cronExpression",
"timezone"
],
"title": "PipelineListSchedule",
"type": "object"
},
{
"type": "null"
}
]
},
"totalRuns": {
"default": 0,
"title": "Totalruns",
"type": "integer"
},
"updatedAt": {
"format": "date-time",
"title": "Updatedat",
"type": "string"
},
"userId": {
"title": "Userid",
"type": "string"
}
},
"required": [
"id",
"name",
"mode",
"isActive",
"userId",
"createdAt",
"updatedAt"
],
"title": "PipelineListItem",
"type": "object"
},
"title": "Data",
"type": "array"
},
"next": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Next"
},
"previous": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Previous"
},
"totalCount": {
"title": "Totalcount",
"type": "integer"
}
},
"required": [
"data",
"totalCount",
"count"
],
"title": "DataPage[PipelineListItem]",
"type": "object"
}
Responses¶
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | Successful Response | DataPage_PipelineListItem_ |
| 422 | Unprocessable Entity | Validation Error | HTTPValidationError |
Create pipeline¶
Operation path: POST /api/v2/pipelines
Upload a Python file that defines a pipeline. The pipeline is created as a draft.
Body parameter¶
properties:
description:
anyOf:
- type: string
- type: "null"
title: Description
file:
contentMediaType: application/octet-stream
title: File
type: string
image_id:
anyOf:
- type: string
- type: "null"
title: Image Id
name:
anyOf:
- type: string
- type: "null"
title: Name
required:
- file
title: Body_createPipeline
type: object
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| body | body | Body_createPipeline | true | none |
Example responses¶
201 Response
{
"description": "Response after creating, updating, or locking a pipeline. ``version`` and ``status`` are ``none`` while the pipeline is in draft mode (since no ``pipelineversion`` row exists yet); they populate to ``1`` / ``ready`` (and beyond) after lock. ``name`` is the pipeline's display label: the user-supplied value when one was provided on upload, or the title-cased ``@pipeline`` function name otherwise (e.g. ``my_workflow`` → ``my workflow``). ``image_id`` is the public objectid of the execution image associated with this pipeline, or ``none`` if no image has been linked.",
"properties": {
"createdAt": {
"format": "date-time",
"title": "Createdat",
"type": "string"
},
"description": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Description"
},
"id": {
"maxLength": 24,
"minLength": 24,
"pattern": "^[0-9a-fA-F]{24}$",
"title": "Id",
"type": "string"
},
"imageId": {
"anyOf": [
{
"maxLength": 24,
"minLength": 24,
"pattern": "^[0-9a-fA-F]{24}$",
"type": "string"
},
{
"type": "null"
}
],
"title": "Imageid"
},
"mode": {
"description": "Pipeline lifecycle mode.",
"enum": [
"draft",
"locked"
],
"title": "PipelineMode",
"type": "string"
},
"name": {
"title": "Name",
"type": "string"
},
"status": {
"anyOf": [
{
"description": "Status of a pipeline version.",
"enum": [
"PENDING",
"READY",
"FAILED"
],
"title": "PipelineVersionStatus",
"type": "string"
},
{
"type": "null"
}
]
},
"taskNames": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Tasknames"
},
"version": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "Version"
}
},
"required": [
"id",
"name",
"mode",
"createdAt"
],
"title": "PipelineCreateResponse",
"type": "object"
}
Responses¶
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 201 | Created | Successful Response | PipelineCreateResponse |
| 422 | Unprocessable Entity | Validation Error | HTTPValidationError |
Delete pipeline by pipeline_ ID¶
Operation path: DELETE /api/v2/pipelines/{pipeline_id}
Delete a pipeline.
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| pipeline_id | path | string | true | Pipeline ID |
Example responses¶
422 Response
{
"properties": {
"detail": {
"items": {
"properties": {
"ctx": {
"title": "Context",
"type": "object"
},
"input": {
"title": "Input"
},
"loc": {
"items": {
"anyOf": [
{
"type": "string"
},
{
"type": "integer"
}
]
},
"title": "Location",
"type": "array"
},
"msg": {
"title": "Message",
"type": "string"
},
"type": {
"title": "Error Type",
"type": "string"
}
},
"required": [
"loc",
"msg",
"type"
],
"title": "ValidationError",
"type": "object"
},
"title": "Detail",
"type": "array"
}
},
"title": "HTTPValidationError",
"type": "object"
}
Responses¶
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 204 | No Content | Successful Response | None |
| 422 | Unprocessable Entity | Validation Error | HTTPValidationError |
Get pipeline by pipeline_ ID¶
Operation path: GET /api/v2/pipelines/{pipeline_id}
Retrieve a pipeline, including its versions.
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| pipeline_id | path | string | true | Pipeline ID |
Example responses¶
200 Response
{
"description": "Full pipeline detail including versions. draft pipelines surface their in-progress pipeline metadata via the top-level ``task_names`` / ``python_version`` / ``resource_bundle`` fields and have an empty ``versions`` array. locked pipelines leave the top-level draft fields ``none`` and expose the same data through one or more ``versions``. ``name`` is the pipeline's display label: the user-supplied value when one was provided on upload, or the title-cased ``@pipeline`` function name otherwise. ``input_set_template`` is a ready-to-submit YAML body for ``post /pipelines/{id}/inputs``: a top-level ``payload`` mapping with a ``null`` placeholder per ``@pipeline`` parameter, derived from the latest available graph (the latest locked version's, or the draft's). it is ``none`` when the pipeline graph is not yet available (e.g. object storage disabled).",
"properties": {
"createdAt": {
"format": "date-time",
"title": "Createdat",
"type": "string"
},
"description": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Description"
},
"id": {
"maxLength": 24,
"minLength": 24,
"pattern": "^[0-9a-fA-F]{24}$",
"title": "Id",
"type": "string"
},
"imageId": {
"anyOf": [
{
"maxLength": 24,
"minLength": 24,
"pattern": "^[0-9a-fA-F]{24}$",
"type": "string"
},
{
"type": "null"
}
],
"title": "Imageid"
},
"inputSetTemplate": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Inputsettemplate"
},
"isActive": {
"title": "Isactive",
"type": "boolean"
},
"linkedImage": {
"anyOf": [
{
"description": "Snapshot of the image version a pipeline is currently bound to. embedded inline in ``pipelinedetailresponse`` so the wizard can drive the run-button affordance without a second round-trip. ``none`` when the pipeline has no image bound.",
"properties": {
"errorDetail": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Errordetail"
},
"imageId": {
"maxLength": 24,
"minLength": 24,
"pattern": "^[0-9a-fA-F]{24}$",
"title": "Imageid",
"type": "string"
},
"name": {
"title": "Name",
"type": "string"
},
"status": {
"description": "Build status of a pipeline image version.",
"enum": [
"CREATING",
"READY",
"ERROR"
],
"title": "PipelineImageStatus",
"type": "string"
},
"version": {
"title": "Version",
"type": "integer"
}
},
"required": [
"imageId",
"name",
"version",
"status"
],
"title": "LinkedImageBlock",
"type": "object"
},
{
"type": "null"
}
]
},
"mode": {
"description": "Pipeline lifecycle mode.",
"enum": [
"draft",
"locked"
],
"title": "PipelineMode",
"type": "string"
},
"name": {
"title": "Name",
"type": "string"
},
"pythonVersion": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Pythonversion"
},
"resourceBundle": {
"anyOf": [
{
"additionalProperties": true,
"type": "object"
},
{
"type": "null"
}
],
"title": "Resourcebundle"
},
"taskNames": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Tasknames"
},
"updatedAt": {
"format": "date-time",
"title": "Updatedat",
"type": "string"
},
"userId": {
"title": "Userid",
"type": "string"
},
"versions": {
"items": {
"description": "Response schema for a single pipeline version.",
"properties": {
"createdAt": {
"format": "date-time",
"title": "Createdat",
"type": "string"
},
"errorDetail": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Errordetail"
},
"pythonVersion": {
"title": "Pythonversion",
"type": "string"
},
"resourceBundle": {
"anyOf": [
{
"additionalProperties": true,
"type": "object"
},
{
"type": "null"
}
],
"title": "Resourcebundle"
},
"status": {
"description": "Status of a pipeline version.",
"enum": [
"PENDING",
"READY",
"FAILED"
],
"title": "PipelineVersionStatus",
"type": "string"
},
"taskNames": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Tasknames"
},
"version": {
"title": "Version",
"type": "integer"
}
},
"required": [
"version",
"status",
"pythonVersion",
"createdAt"
],
"title": "PipelineVersionResponse",
"type": "object"
},
"title": "Versions",
"type": "array"
}
},
"required": [
"id",
"name",
"mode",
"isActive",
"userId",
"createdAt",
"updatedAt"
],
"title": "PipelineDetailResponse",
"type": "object"
}
Responses¶
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | Successful Response | PipelineDetailResponse |
| 422 | Unprocessable Entity | Validation Error | HTTPValidationError |
Update pipeline by pipeline_ ID¶
Operation path: PATCH /api/v2/pipelines/{pipeline_id}
Update a draft pipeline's source file, name, description, or execution image.
Body parameter¶
properties:
description:
anyOf:
- type: string
- type: "null"
title: Description
file:
anyOf:
- contentMediaType: application/octet-stream
type: string
- type: "null"
title: File
image_id:
anyOf:
- type: string
- type: "null"
title: Image Id
name:
anyOf:
- type: string
- type: "null"
title: Name
title: Body_updatePipeline
type: object
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| pipeline_id | path | string | true | Pipeline ID |
| body | body | Body_updatePipeline | false | none |
Example responses¶
200 Response
{
"description": "Response after creating, updating, or locking a pipeline. ``version`` and ``status`` are ``none`` while the pipeline is in draft mode (since no ``pipelineversion`` row exists yet); they populate to ``1`` / ``ready`` (and beyond) after lock. ``name`` is the pipeline's display label: the user-supplied value when one was provided on upload, or the title-cased ``@pipeline`` function name otherwise (e.g. ``my_workflow`` → ``my workflow``). ``image_id`` is the public objectid of the execution image associated with this pipeline, or ``none`` if no image has been linked.",
"properties": {
"createdAt": {
"format": "date-time",
"title": "Createdat",
"type": "string"
},
"description": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Description"
},
"id": {
"maxLength": 24,
"minLength": 24,
"pattern": "^[0-9a-fA-F]{24}$",
"title": "Id",
"type": "string"
},
"imageId": {
"anyOf": [
{
"maxLength": 24,
"minLength": 24,
"pattern": "^[0-9a-fA-F]{24}$",
"type": "string"
},
{
"type": "null"
}
],
"title": "Imageid"
},
"mode": {
"description": "Pipeline lifecycle mode.",
"enum": [
"draft",
"locked"
],
"title": "PipelineMode",
"type": "string"
},
"name": {
"title": "Name",
"type": "string"
},
"status": {
"anyOf": [
{
"description": "Status of a pipeline version.",
"enum": [
"PENDING",
"READY",
"FAILED"
],
"title": "PipelineVersionStatus",
"type": "string"
},
{
"type": "null"
}
]
},
"taskNames": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Tasknames"
},
"version": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "Version"
}
},
"required": [
"id",
"name",
"mode",
"createdAt"
],
"title": "PipelineCreateResponse",
"type": "object"
}
Responses¶
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | Successful Response | PipelineCreateResponse |
| 422 | Unprocessable Entity | Validation Error | HTTPValidationError |
Clone pipeline by pipeline_ ID¶
Operation path: POST /api/v2/pipelines/{pipeline_id}/clone
Create a new draft pipeline from a copy of an existing pipeline.
Body parameter¶
{
"anyOf": [
{
"description": "Request body for cloning an existing pipeline. ``name`` is an optional override for the clone's display label. when omitted or blank, the clone is named ``clone of <source name>`` (with a numeric `` (2)``/`` (3)`` suffix appended on collision). the request body itself is optional — ``post /pipelines/{id}/clone`` with no body clones under the default name.",
"properties": {
"name": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Name"
}
},
"title": "PipelineCloneRequest",
"type": "object"
},
{
"type": "null"
}
],
"title": "Body"
}
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| pipeline_id | path | string | true | Pipeline ID |
| body | body | any | false | none |
Example responses¶
201 Response
{
"description": "Response after creating, updating, or locking a pipeline. ``version`` and ``status`` are ``none`` while the pipeline is in draft mode (since no ``pipelineversion`` row exists yet); they populate to ``1`` / ``ready`` (and beyond) after lock. ``name`` is the pipeline's display label: the user-supplied value when one was provided on upload, or the title-cased ``@pipeline`` function name otherwise (e.g. ``my_workflow`` → ``my workflow``). ``image_id`` is the public objectid of the execution image associated with this pipeline, or ``none`` if no image has been linked.",
"properties": {
"createdAt": {
"format": "date-time",
"title": "Createdat",
"type": "string"
},
"description": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Description"
},
"id": {
"maxLength": 24,
"minLength": 24,
"pattern": "^[0-9a-fA-F]{24}$",
"title": "Id",
"type": "string"
},
"imageId": {
"anyOf": [
{
"maxLength": 24,
"minLength": 24,
"pattern": "^[0-9a-fA-F]{24}$",
"type": "string"
},
{
"type": "null"
}
],
"title": "Imageid"
},
"mode": {
"description": "Pipeline lifecycle mode.",
"enum": [
"draft",
"locked"
],
"title": "PipelineMode",
"type": "string"
},
"name": {
"title": "Name",
"type": "string"
},
"status": {
"anyOf": [
{
"description": "Status of a pipeline version.",
"enum": [
"PENDING",
"READY",
"FAILED"
],
"title": "PipelineVersionStatus",
"type": "string"
},
{
"type": "null"
}
]
},
"taskNames": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Tasknames"
},
"version": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "Version"
}
},
"required": [
"id",
"name",
"mode",
"createdAt"
],
"title": "PipelineCreateResponse",
"type": "object"
}
Responses¶
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 201 | Created | Successful Response | PipelineCreateResponse |
| 422 | Unprocessable Entity | Validation Error | HTTPValidationError |
Get draft pipeline graph by pipeline_ ID¶
Operation path: GET /api/v2/pipelines/{pipeline_id}/graph
Retrieve the task graph of a draft pipeline.
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| pipeline_id | path | string | true | Pipeline ID |
Example responses¶
200 Response
{
"description": "Graph representation of a pipeline's dag for UI rendering. ``warnings`` is populated by the static ast builder when statically- unresolvable constructs (loops, comprehensions, helper indirection, ``*args``/``**kwargs`` splats) are encountered. it is empty for graphs produced post-dispatch from the traced ``transportgraph``.",
"properties": {
"edges": {
"items": {
"description": "A directed data-flow edge between two task nodes.",
"properties": {
"argIndex": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "Argindex"
},
"edgeName": {
"default": "",
"title": "Edgename",
"type": "string"
},
"paramType": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Paramtype"
},
"source": {
"title": "Source",
"type": "integer"
},
"target": {
"title": "Target",
"type": "integer"
}
},
"required": [
"source",
"target"
],
"title": "PipelineGraphEdge",
"type": "object"
},
"title": "Edges",
"type": "array"
},
"nodes": {
"items": {
"description": "A single task node in the pipeline dag.",
"properties": {
"id": {
"title": "Id",
"type": "integer"
},
"name": {
"title": "Name",
"type": "string"
},
"resourceBundle": {
"anyOf": [
{
"additionalProperties": true,
"type": "object"
},
{
"type": "null"
}
],
"title": "Resourcebundle"
},
"source": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Source"
},
"taskGroupId": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "Taskgroupid"
},
"taskId": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "Taskid"
},
"type": {
"default": "function",
"title": "Type",
"type": "string"
}
},
"required": [
"id",
"name"
],
"title": "PipelineGraphNode",
"type": "object"
},
"title": "Nodes",
"type": "array"
},
"pipeline": {
"description": "Pipeline metadata in the graph response.",
"properties": {
"name": {
"title": "Name",
"type": "string"
},
"parameters": {
"items": {
"additionalProperties": true,
"type": "object"
},
"title": "Parameters",
"type": "array"
},
"pythonVersion": {
"title": "Pythonversion",
"type": "string"
}
},
"required": [
"name",
"pythonVersion"
],
"title": "PipelineGraphMeta",
"type": "object"
},
"warnings": {
"items": {
"type": "string"
},
"title": "Warnings",
"type": "array"
}
},
"required": [
"pipeline"
],
"title": "PipelineGraph",
"type": "object"
}
Responses¶
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | Successful Response | PipelineGraph |
| 422 | Unprocessable Entity | Validation Error | HTTPValidationError |
Lock pipeline by pipeline_ ID¶
Operation path: PATCH /api/v2/pipelines/{pipeline_id}/mode
Lock a draft pipeline, creating a new immutable pipeline version.
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| pipeline_id | path | string | true | Pipeline ID |
Example responses¶
200 Response
{
"description": "Response after creating, updating, or locking a pipeline. ``version`` and ``status`` are ``none`` while the pipeline is in draft mode (since no ``pipelineversion`` row exists yet); they populate to ``1`` / ``ready`` (and beyond) after lock. ``name`` is the pipeline's display label: the user-supplied value when one was provided on upload, or the title-cased ``@pipeline`` function name otherwise (e.g. ``my_workflow`` → ``my workflow``). ``image_id`` is the public objectid of the execution image associated with this pipeline, or ``none`` if no image has been linked.",
"properties": {
"createdAt": {
"format": "date-time",
"title": "Createdat",
"type": "string"
},
"description": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Description"
},
"id": {
"maxLength": 24,
"minLength": 24,
"pattern": "^[0-9a-fA-F]{24}$",
"title": "Id",
"type": "string"
},
"imageId": {
"anyOf": [
{
"maxLength": 24,
"minLength": 24,
"pattern": "^[0-9a-fA-F]{24}$",
"type": "string"
},
{
"type": "null"
}
],
"title": "Imageid"
},
"mode": {
"description": "Pipeline lifecycle mode.",
"enum": [
"draft",
"locked"
],
"title": "PipelineMode",
"type": "string"
},
"name": {
"title": "Name",
"type": "string"
},
"status": {
"anyOf": [
{
"description": "Status of a pipeline version.",
"enum": [
"PENDING",
"READY",
"FAILED"
],
"title": "PipelineVersionStatus",
"type": "string"
},
{
"type": "null"
}
]
},
"taskNames": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Tasknames"
},
"version": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "Version"
}
},
"required": [
"id",
"name",
"mode",
"createdAt"
],
"title": "PipelineCreateResponse",
"type": "object"
}
Responses¶
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | Successful Response | PipelineCreateResponse |
| 422 | Unprocessable Entity | Validation Error | HTTPValidationError |
Get draft pipeline source by pipeline_ ID¶
Operation path: GET /api/v2/pipelines/{pipeline_id}/source
Retrieve the source file of a draft pipeline.
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| pipeline_id | path | string | true | Pipeline ID |
Example responses¶
200 Response
{
"description": "Full source code of an uploaded pipeline file. ``source`` is the raw text of the ``source.py`` asset stored in object storage at upload / re-upload time. it is identical to what the user originally uploaded, preserving comments, imports, and all task definitions — not just the ``@pipeline``-decorated function.",
"properties": {
"source": {
"title": "Source",
"type": "string"
}
},
"required": [
"source"
],
"title": "PipelineSourceResponse",
"type": "object"
}
Responses¶
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | Successful Response | PipelineSourceResponse |
| 422 | Unprocessable Entity | Validation Error | HTTPValidationError |
Get draft pipeline task by pipeline_ ID¶
Operation path: GET /api/v2/pipelines/{pipeline_id}/tasks/{task_id}
Retrieve a task in a draft pipeline.
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| pipeline_id | path | string | true | Pipeline ID |
| task_id | path | integer | true | Task ID |
Example responses¶
200 Response
{
"description": "Response schema for a pipeline task detail endpoint.",
"properties": {
"id": {
"title": "Id",
"type": "integer"
},
"inputs": {
"anyOf": [
{
"additionalProperties": true,
"type": "object"
},
{
"type": "null"
}
],
"title": "Inputs"
},
"name": {
"title": "Name",
"type": "string"
},
"parameters": {
"items": {
"description": "A single parameter from a ``@task`` function signature.",
"properties": {
"annotation": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Annotation"
},
"name": {
"title": "Name",
"type": "string"
}
},
"required": [
"name"
],
"title": "TaskParameter",
"type": "object"
},
"title": "Parameters",
"type": "array"
},
"pipelineId": {
"maxLength": 24,
"minLength": 24,
"pattern": "^[0-9a-fA-F]{24}$",
"title": "Pipelineid",
"type": "string"
},
"resourceBundle": {
"anyOf": [
{
"additionalProperties": true,
"type": "object"
},
{
"type": "null"
}
],
"title": "Resourcebundle"
},
"resourceBundleId": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Resourcebundleid"
},
"source": {
"title": "Source",
"type": "string"
},
"taskGroupId": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "Taskgroupid"
},
"versionId": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "Versionid"
}
},
"required": [
"id",
"pipelineId",
"name",
"parameters",
"source"
],
"title": "TaskResponse",
"type": "object"
}
Responses¶
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | Successful Response | TaskResponse |
| 422 | Unprocessable Entity | Validation Error | HTTPValidationError |
List pipeline versions by pipeline_ ID¶
Operation path: GET /api/v2/pipelines/{pipeline_id}/versions
List the locked versions of a pipeline.
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| pipeline_id | path | string | true | Pipeline ID |
| offset | query | integer | false | none |
| limit | query | integer | false | none |
Example responses¶
200 Response
{
"properties": {
"count": {
"readOnly": true,
"title": "Count",
"type": "integer"
},
"data": {
"items": {
"description": "Response schema for a single pipeline version.",
"properties": {
"createdAt": {
"format": "date-time",
"title": "Createdat",
"type": "string"
},
"errorDetail": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Errordetail"
},
"pythonVersion": {
"title": "Pythonversion",
"type": "string"
},
"resourceBundle": {
"anyOf": [
{
"additionalProperties": true,
"type": "object"
},
{
"type": "null"
}
],
"title": "Resourcebundle"
},
"status": {
"description": "Status of a pipeline version.",
"enum": [
"PENDING",
"READY",
"FAILED"
],
"title": "PipelineVersionStatus",
"type": "string"
},
"taskNames": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Tasknames"
},
"version": {
"title": "Version",
"type": "integer"
}
},
"required": [
"version",
"status",
"pythonVersion",
"createdAt"
],
"title": "PipelineVersionResponse",
"type": "object"
},
"title": "Data",
"type": "array"
},
"next": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Next"
},
"previous": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Previous"
},
"totalCount": {
"title": "Totalcount",
"type": "integer"
}
},
"required": [
"data",
"totalCount",
"count"
],
"title": "DataPage[PipelineVersionResponse]",
"type": "object"
}
Responses¶
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | Successful Response | DataPage_PipelineVersionResponse_ |
| 422 | Unprocessable Entity | Validation Error | HTTPValidationError |
Get pipeline version by pipeline_ ID¶
Operation path: GET /api/v2/pipelines/{pipeline_id}/versions/{version_id}
Retrieve a locked version of a pipeline.
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| pipeline_id | path | string | true | Pipeline ID |
| version_id | path | integer | true | Pipeline version number |
Example responses¶
200 Response
{
"description": "Response schema for a single pipeline version.",
"properties": {
"createdAt": {
"format": "date-time",
"title": "Createdat",
"type": "string"
},
"errorDetail": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Errordetail"
},
"pythonVersion": {
"title": "Pythonversion",
"type": "string"
},
"resourceBundle": {
"anyOf": [
{
"additionalProperties": true,
"type": "object"
},
{
"type": "null"
}
],
"title": "Resourcebundle"
},
"status": {
"description": "Status of a pipeline version.",
"enum": [
"PENDING",
"READY",
"FAILED"
],
"title": "PipelineVersionStatus",
"type": "string"
},
"taskNames": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Tasknames"
},
"version": {
"title": "Version",
"type": "integer"
}
},
"required": [
"version",
"status",
"pythonVersion",
"createdAt"
],
"title": "PipelineVersionResponse",
"type": "object"
}
Responses¶
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | Successful Response | PipelineVersionResponse |
| 422 | Unprocessable Entity | Validation Error | HTTPValidationError |
Get pipeline version graph by pipeline_ ID¶
Operation path: GET /api/v2/pipelines/{pipeline_id}/versions/{version_id}/graph
Retrieve the task graph of a locked pipeline version.
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| pipeline_id | path | string | true | Pipeline ID |
| version_id | path | integer | true | Pipeline version number |
Example responses¶
200 Response
{
"description": "Graph representation of a pipeline's dag for UI rendering. ``warnings`` is populated by the static ast builder when statically- unresolvable constructs (loops, comprehensions, helper indirection, ``*args``/``**kwargs`` splats) are encountered. it is empty for graphs produced post-dispatch from the traced ``transportgraph``.",
"properties": {
"edges": {
"items": {
"description": "A directed data-flow edge between two task nodes.",
"properties": {
"argIndex": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "Argindex"
},
"edgeName": {
"default": "",
"title": "Edgename",
"type": "string"
},
"paramType": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Paramtype"
},
"source": {
"title": "Source",
"type": "integer"
},
"target": {
"title": "Target",
"type": "integer"
}
},
"required": [
"source",
"target"
],
"title": "PipelineGraphEdge",
"type": "object"
},
"title": "Edges",
"type": "array"
},
"nodes": {
"items": {
"description": "A single task node in the pipeline dag.",
"properties": {
"id": {
"title": "Id",
"type": "integer"
},
"name": {
"title": "Name",
"type": "string"
},
"resourceBundle": {
"anyOf": [
{
"additionalProperties": true,
"type": "object"
},
{
"type": "null"
}
],
"title": "Resourcebundle"
},
"source": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Source"
},
"taskGroupId": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "Taskgroupid"
},
"taskId": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "Taskid"
},
"type": {
"default": "function",
"title": "Type",
"type": "string"
}
},
"required": [
"id",
"name"
],
"title": "PipelineGraphNode",
"type": "object"
},
"title": "Nodes",
"type": "array"
},
"pipeline": {
"description": "Pipeline metadata in the graph response.",
"properties": {
"name": {
"title": "Name",
"type": "string"
},
"parameters": {
"items": {
"additionalProperties": true,
"type": "object"
},
"title": "Parameters",
"type": "array"
},
"pythonVersion": {
"title": "Pythonversion",
"type": "string"
}
},
"required": [
"name",
"pythonVersion"
],
"title": "PipelineGraphMeta",
"type": "object"
},
"warnings": {
"items": {
"type": "string"
},
"title": "Warnings",
"type": "array"
}
},
"required": [
"pipeline"
],
"title": "PipelineGraph",
"type": "object"
}
Responses¶
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | Successful Response | PipelineGraph |
| 422 | Unprocessable Entity | Validation Error | HTTPValidationError |
Get pipeline version source by pipeline_ ID¶
Operation path: GET /api/v2/pipelines/{pipeline_id}/versions/{version_id}/source
Retrieve the source file of a locked pipeline version.
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| pipeline_id | path | string | true | Pipeline ID |
| version_id | path | integer | true | Pipeline version number |
Example responses¶
200 Response
{
"description": "Full source code of an uploaded pipeline file. ``source`` is the raw text of the ``source.py`` asset stored in object storage at upload / re-upload time. it is identical to what the user originally uploaded, preserving comments, imports, and all task definitions — not just the ``@pipeline``-decorated function.",
"properties": {
"source": {
"title": "Source",
"type": "string"
}
},
"required": [
"source"
],
"title": "PipelineSourceResponse",
"type": "object"
}
Responses¶
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | Successful Response | PipelineSourceResponse |
| 422 | Unprocessable Entity | Validation Error | HTTPValidationError |
Get pipeline version task by pipeline_ ID¶
Operation path: GET /api/v2/pipelines/{pipeline_id}/versions/{version_id}/tasks/{task_id}
Retrieve a task in a locked pipeline version.
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| pipeline_id | path | string | true | Pipeline ID |
| version_id | path | integer | true | Pipeline version number |
| task_id | path | integer | true | Task ID |
Example responses¶
200 Response
{
"description": "Response schema for a pipeline task detail endpoint.",
"properties": {
"id": {
"title": "Id",
"type": "integer"
},
"inputs": {
"anyOf": [
{
"additionalProperties": true,
"type": "object"
},
{
"type": "null"
}
],
"title": "Inputs"
},
"name": {
"title": "Name",
"type": "string"
},
"parameters": {
"items": {
"description": "A single parameter from a ``@task`` function signature.",
"properties": {
"annotation": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Annotation"
},
"name": {
"title": "Name",
"type": "string"
}
},
"required": [
"name"
],
"title": "TaskParameter",
"type": "object"
},
"title": "Parameters",
"type": "array"
},
"pipelineId": {
"maxLength": 24,
"minLength": 24,
"pattern": "^[0-9a-fA-F]{24}$",
"title": "Pipelineid",
"type": "string"
},
"resourceBundle": {
"anyOf": [
{
"additionalProperties": true,
"type": "object"
},
{
"type": "null"
}
],
"title": "Resourcebundle"
},
"resourceBundleId": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Resourcebundleid"
},
"source": {
"title": "Source",
"type": "string"
},
"taskGroupId": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "Taskgroupid"
},
"versionId": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "Versionid"
}
},
"required": [
"id",
"pipelineId",
"name",
"parameters",
"source"
],
"title": "TaskResponse",
"type": "object"
}
Responses¶
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | Successful Response | TaskResponse |
| 422 | Unprocessable Entity | Validation Error | HTTPValidationError |
Schemas¶
Body_createPipeline
{
"properties": {
"description": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Description"
},
"file": {
"contentMediaType": "application/octet-stream",
"title": "File",
"type": "string"
},
"image_id": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Image Id"
},
"name": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Name"
}
},
"required": [
"file"
],
"title": "Body_createPipeline",
"type": "object"
}
Body_createPipeline
Properties¶
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| description | any | false | none |
anyOf
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| » anonymous | string | false | none |
or
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| » anonymous | null | false | none |
continued
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| file | string | true | none | |
| image_id | any | false | none |
anyOf
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| » anonymous | string | false | none |
or
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| » anonymous | null | false | none |
continued
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| name | any | false | none |
anyOf
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| » anonymous | string | false | none |
or
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| » anonymous | null | false | none |
Body_updatePipeline
{
"properties": {
"description": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Description"
},
"file": {
"anyOf": [
{
"contentMediaType": "application/octet-stream",
"type": "string"
},
{
"type": "null"
}
],
"title": "File"
},
"image_id": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Image Id"
},
"name": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Name"
}
},
"title": "Body_updatePipeline",
"type": "object"
}
Body_updatePipeline
Properties¶
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| description | any | false | none |
anyOf
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| » anonymous | string | false | none |
or
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| » anonymous | null | false | none |
continued
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| file | any | false | none |
anyOf
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| » anonymous | string | false | none |
or
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| » anonymous | null | false | none |
continued
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| image_id | any | false | none |
anyOf
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| » anonymous | string | false | none |
or
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| » anonymous | null | false | none |
continued
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| name | any | false | none |
anyOf
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| » anonymous | string | false | none |
or
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| » anonymous | null | false | none |
DataPage_PipelineListItem_
{
"properties": {
"count": {
"readOnly": true,
"title": "Count",
"type": "integer"
},
"data": {
"items": {
"description": "Single item in a pipeline list response. ``name`` is the pipeline's display label: the user-supplied value when one was provided on upload, or the title-cased ``@pipeline`` function name otherwise. ``total_runs`` is the total number of dispatches across all versions. ``schedule`` is the most recently created active schedule for the pipeline, or ``none`` when no active schedule exists.",
"properties": {
"createdAt": {
"format": "date-time",
"title": "Createdat",
"type": "string"
},
"description": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Description"
},
"id": {
"maxLength": 24,
"minLength": 24,
"pattern": "^[0-9a-fA-F]{24}$",
"title": "Id",
"type": "string"
},
"isActive": {
"title": "Isactive",
"type": "boolean"
},
"latestVersion": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "Latestversion"
},
"mode": {
"description": "Pipeline lifecycle mode.",
"enum": [
"draft",
"locked"
],
"title": "PipelineMode",
"type": "string"
},
"name": {
"title": "Name",
"type": "string"
},
"schedule": {
"anyOf": [
{
"description": "Active schedule summary surfaced on the pipeline list.",
"properties": {
"cronExpression": {
"title": "Cronexpression",
"type": "string"
},
"timezone": {
"title": "Timezone",
"type": "string"
}
},
"required": [
"cronExpression",
"timezone"
],
"title": "PipelineListSchedule",
"type": "object"
},
{
"type": "null"
}
]
},
"totalRuns": {
"default": 0,
"title": "Totalruns",
"type": "integer"
},
"updatedAt": {
"format": "date-time",
"title": "Updatedat",
"type": "string"
},
"userId": {
"title": "Userid",
"type": "string"
}
},
"required": [
"id",
"name",
"mode",
"isActive",
"userId",
"createdAt",
"updatedAt"
],
"title": "PipelineListItem",
"type": "object"
},
"title": "Data",
"type": "array"
},
"next": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Next"
},
"previous": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Previous"
},
"totalCount": {
"title": "Totalcount",
"type": "integer"
}
},
"required": [
"data",
"totalCount",
"count"
],
"title": "DataPage[PipelineListItem]",
"type": "object"
}
DataPage[PipelineListItem]
Properties¶
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| count | integer | true | none | |
| data | [PipelineListItem] | true | [Single item in a pipeline list response. name is the pipeline's display label: the user-supplied value when one was provided on upload, or the title-cased @pipeline function name otherwise. total_runs is the total number of dispatches across all versions. schedule is the most recently created active schedule for the pipeline, or none when no active schedule exists.] |
|
| next | any | false | none |
anyOf
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| » anonymous | string | false | none |
or
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| » anonymous | null | false | none |
continued
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| previous | any | false | none |
anyOf
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| » anonymous | string | false | none |
or
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| » anonymous | null | false | none |
continued
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| totalCount | integer | true | none |
DataPage_PipelineVersionResponse_
{
"properties": {
"count": {
"readOnly": true,
"title": "Count",
"type": "integer"
},
"data": {
"items": {
"description": "Response schema for a single pipeline version.",
"properties": {
"createdAt": {
"format": "date-time",
"title": "Createdat",
"type": "string"
},
"errorDetail": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Errordetail"
},
"pythonVersion": {
"title": "Pythonversion",
"type": "string"
},
"resourceBundle": {
"anyOf": [
{
"additionalProperties": true,
"type": "object"
},
{
"type": "null"
}
],
"title": "Resourcebundle"
},
"status": {
"description": "Status of a pipeline version.",
"enum": [
"PENDING",
"READY",
"FAILED"
],
"title": "PipelineVersionStatus",
"type": "string"
},
"taskNames": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Tasknames"
},
"version": {
"title": "Version",
"type": "integer"
}
},
"required": [
"version",
"status",
"pythonVersion",
"createdAt"
],
"title": "PipelineVersionResponse",
"type": "object"
},
"title": "Data",
"type": "array"
},
"next": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Next"
},
"previous": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Previous"
},
"totalCount": {
"title": "Totalcount",
"type": "integer"
}
},
"required": [
"data",
"totalCount",
"count"
],
"title": "DataPage[PipelineVersionResponse]",
"type": "object"
}
DataPage[PipelineVersionResponse]
Properties¶
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| count | integer | true | none | |
| data | [PipelineVersionResponse] | true | [Response schema for a single pipeline version.] | |
| next | any | false | none |
anyOf
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| » anonymous | string | false | none |
or
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| » anonymous | null | false | none |
continued
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| previous | any | false | none |
anyOf
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| » anonymous | string | false | none |
or
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| » anonymous | null | false | none |
continued
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| totalCount | integer | true | none |
HTTPValidationError
{
"properties": {
"detail": {
"items": {
"properties": {
"ctx": {
"title": "Context",
"type": "object"
},
"input": {
"title": "Input"
},
"loc": {
"items": {
"anyOf": [
{
"type": "string"
},
{
"type": "integer"
}
]
},
"title": "Location",
"type": "array"
},
"msg": {
"title": "Message",
"type": "string"
},
"type": {
"title": "Error Type",
"type": "string"
}
},
"required": [
"loc",
"msg",
"type"
],
"title": "ValidationError",
"type": "object"
},
"title": "Detail",
"type": "array"
}
},
"title": "HTTPValidationError",
"type": "object"
}
HTTPValidationError
Properties¶
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| detail | [ValidationError] | false | none |
LinkedImageBlock
{
"description": "Snapshot of the image version a pipeline is currently bound to. embedded inline in ``pipelinedetailresponse`` so the wizard can drive the run-button affordance without a second round-trip. ``none`` when the pipeline has no image bound.",
"properties": {
"errorDetail": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Errordetail"
},
"imageId": {
"maxLength": 24,
"minLength": 24,
"pattern": "^[0-9a-fA-F]{24}$",
"title": "Imageid",
"type": "string"
},
"name": {
"title": "Name",
"type": "string"
},
"status": {
"description": "Build status of a pipeline image version.",
"enum": [
"CREATING",
"READY",
"ERROR"
],
"title": "PipelineImageStatus",
"type": "string"
},
"version": {
"title": "Version",
"type": "integer"
}
},
"required": [
"imageId",
"name",
"version",
"status"
],
"title": "LinkedImageBlock",
"type": "object"
}
LinkedImageBlock
Properties¶
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| errorDetail | any | false | none |
anyOf
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| » anonymous | string | false | none |
or
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| » anonymous | null | false | none |
continued
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| imageId | string | true | maxLength: 24 minLength: 24 minLength: 24 |
none |
| name | string | true | none | |
| status | PipelineImageStatus | true | Build status of a pipeline image version. | |
| version | integer | true | none |
PipelineCloneRequest
{
"description": "Request body for cloning an existing pipeline. ``name`` is an optional override for the clone's display label. when omitted or blank, the clone is named ``clone of <source name>`` (with a numeric `` (2)``/`` (3)`` suffix appended on collision). the request body itself is optional — ``post /pipelines/{id}/clone`` with no body clones under the default name.",
"properties": {
"name": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Name"
}
},
"title": "PipelineCloneRequest",
"type": "object"
}
PipelineCloneRequest
Properties¶
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| name | any | false | none |
anyOf
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| » anonymous | string | false | none |
or
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| » anonymous | null | false | none |
PipelineCreateResponse
{
"description": "Response after creating, updating, or locking a pipeline. ``version`` and ``status`` are ``none`` while the pipeline is in draft mode (since no ``pipelineversion`` row exists yet); they populate to ``1`` / ``ready`` (and beyond) after lock. ``name`` is the pipeline's display label: the user-supplied value when one was provided on upload, or the title-cased ``@pipeline`` function name otherwise (e.g. ``my_workflow`` → ``my workflow``). ``image_id`` is the public objectid of the execution image associated with this pipeline, or ``none`` if no image has been linked.",
"properties": {
"createdAt": {
"format": "date-time",
"title": "Createdat",
"type": "string"
},
"description": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Description"
},
"id": {
"maxLength": 24,
"minLength": 24,
"pattern": "^[0-9a-fA-F]{24}$",
"title": "Id",
"type": "string"
},
"imageId": {
"anyOf": [
{
"maxLength": 24,
"minLength": 24,
"pattern": "^[0-9a-fA-F]{24}$",
"type": "string"
},
{
"type": "null"
}
],
"title": "Imageid"
},
"mode": {
"description": "Pipeline lifecycle mode.",
"enum": [
"draft",
"locked"
],
"title": "PipelineMode",
"type": "string"
},
"name": {
"title": "Name",
"type": "string"
},
"status": {
"anyOf": [
{
"description": "Status of a pipeline version.",
"enum": [
"PENDING",
"READY",
"FAILED"
],
"title": "PipelineVersionStatus",
"type": "string"
},
{
"type": "null"
}
]
},
"taskNames": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Tasknames"
},
"version": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "Version"
}
},
"required": [
"id",
"name",
"mode",
"createdAt"
],
"title": "PipelineCreateResponse",
"type": "object"
}
PipelineCreateResponse
Properties¶
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| createdAt | string(date-time) | true | none | |
| description | any | false | none |
anyOf
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| » anonymous | string | false | none |
or
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| » anonymous | null | false | none |
continued
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| id | string | true | maxLength: 24 minLength: 24 minLength: 24 |
none |
| imageId | any | false | none |
anyOf
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| » anonymous | string | false | maxLength: 24 minLength: 24 minLength: 24 |
none |
or
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| » anonymous | null | false | none |
continued
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| mode | PipelineMode | true | Pipeline lifecycle mode. | |
| name | string | true | none | |
| status | any | false | none |
anyOf
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| » anonymous | PipelineVersionStatus | false | Status of a pipeline version. |
or
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| » anonymous | null | false | none |
continued
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| taskNames | any | false | none |
anyOf
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| » anonymous | [string] | false | none |
or
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| » anonymous | null | false | none |
continued
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| version | any | false | none |
anyOf
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| » anonymous | integer | false | none |
or
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| » anonymous | null | false | none |
PipelineDetailResponse
{
"description": "Full pipeline detail including versions. draft pipelines surface their in-progress pipeline metadata via the top-level ``task_names`` / ``python_version`` / ``resource_bundle`` fields and have an empty ``versions`` array. locked pipelines leave the top-level draft fields ``none`` and expose the same data through one or more ``versions``. ``name`` is the pipeline's display label: the user-supplied value when one was provided on upload, or the title-cased ``@pipeline`` function name otherwise. ``input_set_template`` is a ready-to-submit YAML body for ``post /pipelines/{id}/inputs``: a top-level ``payload`` mapping with a ``null`` placeholder per ``@pipeline`` parameter, derived from the latest available graph (the latest locked version's, or the draft's). it is ``none`` when the pipeline graph is not yet available (e.g. object storage disabled).",
"properties": {
"createdAt": {
"format": "date-time",
"title": "Createdat",
"type": "string"
},
"description": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Description"
},
"id": {
"maxLength": 24,
"minLength": 24,
"pattern": "^[0-9a-fA-F]{24}$",
"title": "Id",
"type": "string"
},
"imageId": {
"anyOf": [
{
"maxLength": 24,
"minLength": 24,
"pattern": "^[0-9a-fA-F]{24}$",
"type": "string"
},
{
"type": "null"
}
],
"title": "Imageid"
},
"inputSetTemplate": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Inputsettemplate"
},
"isActive": {
"title": "Isactive",
"type": "boolean"
},
"linkedImage": {
"anyOf": [
{
"description": "Snapshot of the image version a pipeline is currently bound to. embedded inline in ``pipelinedetailresponse`` so the wizard can drive the run-button affordance without a second round-trip. ``none`` when the pipeline has no image bound.",
"properties": {
"errorDetail": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Errordetail"
},
"imageId": {
"maxLength": 24,
"minLength": 24,
"pattern": "^[0-9a-fA-F]{24}$",
"title": "Imageid",
"type": "string"
},
"name": {
"title": "Name",
"type": "string"
},
"status": {
"description": "Build status of a pipeline image version.",
"enum": [
"CREATING",
"READY",
"ERROR"
],
"title": "PipelineImageStatus",
"type": "string"
},
"version": {
"title": "Version",
"type": "integer"
}
},
"required": [
"imageId",
"name",
"version",
"status"
],
"title": "LinkedImageBlock",
"type": "object"
},
{
"type": "null"
}
]
},
"mode": {
"description": "Pipeline lifecycle mode.",
"enum": [
"draft",
"locked"
],
"title": "PipelineMode",
"type": "string"
},
"name": {
"title": "Name",
"type": "string"
},
"pythonVersion": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Pythonversion"
},
"resourceBundle": {
"anyOf": [
{
"additionalProperties": true,
"type": "object"
},
{
"type": "null"
}
],
"title": "Resourcebundle"
},
"taskNames": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Tasknames"
},
"updatedAt": {
"format": "date-time",
"title": "Updatedat",
"type": "string"
},
"userId": {
"title": "Userid",
"type": "string"
},
"versions": {
"items": {
"description": "Response schema for a single pipeline version.",
"properties": {
"createdAt": {
"format": "date-time",
"title": "Createdat",
"type": "string"
},
"errorDetail": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Errordetail"
},
"pythonVersion": {
"title": "Pythonversion",
"type": "string"
},
"resourceBundle": {
"anyOf": [
{
"additionalProperties": true,
"type": "object"
},
{
"type": "null"
}
],
"title": "Resourcebundle"
},
"status": {
"description": "Status of a pipeline version.",
"enum": [
"PENDING",
"READY",
"FAILED"
],
"title": "PipelineVersionStatus",
"type": "string"
},
"taskNames": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Tasknames"
},
"version": {
"title": "Version",
"type": "integer"
}
},
"required": [
"version",
"status",
"pythonVersion",
"createdAt"
],
"title": "PipelineVersionResponse",
"type": "object"
},
"title": "Versions",
"type": "array"
}
},
"required": [
"id",
"name",
"mode",
"isActive",
"userId",
"createdAt",
"updatedAt"
],
"title": "PipelineDetailResponse",
"type": "object"
}
PipelineDetailResponse
Properties¶
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| createdAt | string(date-time) | true | none | |
| description | any | false | none |
anyOf
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| » anonymous | string | false | none |
or
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| » anonymous | null | false | none |
continued
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| id | string | true | maxLength: 24 minLength: 24 minLength: 24 |
none |
| imageId | any | false | none |
anyOf
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| » anonymous | string | false | maxLength: 24 minLength: 24 minLength: 24 |
none |
or
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| » anonymous | null | false | none |
continued
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| inputSetTemplate | any | false | none |
anyOf
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| » anonymous | string | false | none |
or
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| » anonymous | null | false | none |
continued
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| isActive | boolean | true | none | |
| linkedImage | any | false | none |
anyOf
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| » anonymous | LinkedImageBlock | false | Snapshot of the image version a pipeline is currently bound to. embedded inline in pipelinedetailresponse so the wizard can drive the run-button affordance without a second round-trip. none when the pipeline has no image bound. |
or
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| » anonymous | null | false | none |
continued
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| mode | PipelineMode | true | Pipeline lifecycle mode. | |
| name | string | true | none | |
| pythonVersion | any | false | none |
anyOf
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| » anonymous | string | false | none |
or
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| » anonymous | null | false | none |
continued
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| resourceBundle | any | false | none |
anyOf
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| » anonymous | object | false | none |
or
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| » anonymous | null | false | none |
continued
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| taskNames | any | false | none |
anyOf
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| » anonymous | [string] | false | none |
or
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| » anonymous | null | false | none |
continued
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| updatedAt | string(date-time) | true | none | |
| userId | string | true | none | |
| versions | [PipelineVersionResponse] | false | [Response schema for a single pipeline version.] |
PipelineGraph
{
"description": "Graph representation of a pipeline's dag for UI rendering. ``warnings`` is populated by the static ast builder when statically- unresolvable constructs (loops, comprehensions, helper indirection, ``*args``/``**kwargs`` splats) are encountered. it is empty for graphs produced post-dispatch from the traced ``transportgraph``.",
"properties": {
"edges": {
"items": {
"description": "A directed data-flow edge between two task nodes.",
"properties": {
"argIndex": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "Argindex"
},
"edgeName": {
"default": "",
"title": "Edgename",
"type": "string"
},
"paramType": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Paramtype"
},
"source": {
"title": "Source",
"type": "integer"
},
"target": {
"title": "Target",
"type": "integer"
}
},
"required": [
"source",
"target"
],
"title": "PipelineGraphEdge",
"type": "object"
},
"title": "Edges",
"type": "array"
},
"nodes": {
"items": {
"description": "A single task node in the pipeline dag.",
"properties": {
"id": {
"title": "Id",
"type": "integer"
},
"name": {
"title": "Name",
"type": "string"
},
"resourceBundle": {
"anyOf": [
{
"additionalProperties": true,
"type": "object"
},
{
"type": "null"
}
],
"title": "Resourcebundle"
},
"source": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Source"
},
"taskGroupId": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "Taskgroupid"
},
"taskId": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "Taskid"
},
"type": {
"default": "function",
"title": "Type",
"type": "string"
}
},
"required": [
"id",
"name"
],
"title": "PipelineGraphNode",
"type": "object"
},
"title": "Nodes",
"type": "array"
},
"pipeline": {
"description": "Pipeline metadata in the graph response.",
"properties": {
"name": {
"title": "Name",
"type": "string"
},
"parameters": {
"items": {
"additionalProperties": true,
"type": "object"
},
"title": "Parameters",
"type": "array"
},
"pythonVersion": {
"title": "Pythonversion",
"type": "string"
}
},
"required": [
"name",
"pythonVersion"
],
"title": "PipelineGraphMeta",
"type": "object"
},
"warnings": {
"items": {
"type": "string"
},
"title": "Warnings",
"type": "array"
}
},
"required": [
"pipeline"
],
"title": "PipelineGraph",
"type": "object"
}
PipelineGraph
Properties¶
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| edges | [PipelineGraphEdge] | false | [A directed data-flow edge between two task nodes.] | |
| nodes | [PipelineGraphNode] | false | [A single task node in the pipeline dag.] | |
| pipeline | PipelineGraphMeta | true | Pipeline metadata in the graph response. | |
| warnings | [string] | false | none |
PipelineGraphEdge
{
"description": "A directed data-flow edge between two task nodes.",
"properties": {
"argIndex": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "Argindex"
},
"edgeName": {
"default": "",
"title": "Edgename",
"type": "string"
},
"paramType": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Paramtype"
},
"source": {
"title": "Source",
"type": "integer"
},
"target": {
"title": "Target",
"type": "integer"
}
},
"required": [
"source",
"target"
],
"title": "PipelineGraphEdge",
"type": "object"
}
PipelineGraphEdge
Properties¶
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| argIndex | any | false | none |
anyOf
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| » anonymous | integer | false | none |
or
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| » anonymous | null | false | none |
continued
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| edgeName | string | false | none | |
| paramType | any | false | none |
anyOf
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| » anonymous | string | false | none |
or
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| » anonymous | null | false | none |
continued
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| source | integer | true | none | |
| target | integer | true | none |
PipelineGraphMeta
{
"description": "Pipeline metadata in the graph response.",
"properties": {
"name": {
"title": "Name",
"type": "string"
},
"parameters": {
"items": {
"additionalProperties": true,
"type": "object"
},
"title": "Parameters",
"type": "array"
},
"pythonVersion": {
"title": "Pythonversion",
"type": "string"
}
},
"required": [
"name",
"pythonVersion"
],
"title": "PipelineGraphMeta",
"type": "object"
}
PipelineGraphMeta
Properties¶
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| name | string | true | none | |
| parameters | [object] | false | none | |
| pythonVersion | string | true | none |
PipelineGraphNode
{
"description": "A single task node in the pipeline dag.",
"properties": {
"id": {
"title": "Id",
"type": "integer"
},
"name": {
"title": "Name",
"type": "string"
},
"resourceBundle": {
"anyOf": [
{
"additionalProperties": true,
"type": "object"
},
{
"type": "null"
}
],
"title": "Resourcebundle"
},
"source": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Source"
},
"taskGroupId": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "Taskgroupid"
},
"taskId": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "Taskid"
},
"type": {
"default": "function",
"title": "Type",
"type": "string"
}
},
"required": [
"id",
"name"
],
"title": "PipelineGraphNode",
"type": "object"
}
PipelineGraphNode
Properties¶
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| id | integer | true | none | |
| name | string | true | none | |
| resourceBundle | any | false | none |
anyOf
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| » anonymous | object | false | none |
or
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| » anonymous | null | false | none |
continued
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| source | any | false | none |
anyOf
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| » anonymous | string | false | none |
or
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| » anonymous | null | false | none |
continued
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| taskGroupId | any | false | none |
anyOf
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| » anonymous | integer | false | none |
or
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| » anonymous | null | false | none |
continued
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| taskId | any | false | none |
anyOf
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| » anonymous | integer | false | none |
or
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| » anonymous | null | false | none |
continued
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| type | string | false | none |
PipelineImageStatus
{
"description": "Build status of a pipeline image version.",
"enum": [
"CREATING",
"READY",
"ERROR"
],
"title": "PipelineImageStatus",
"type": "string"
}
PipelineImageStatus
Properties¶
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| PipelineImageStatus | string | false | Build status of a pipeline image version. |
Enumerated Values¶
| Property | Value |
|---|---|
| PipelineImageStatus | [CREATING, READY, ERROR] |
PipelineListItem
{
"description": "Single item in a pipeline list response. ``name`` is the pipeline's display label: the user-supplied value when one was provided on upload, or the title-cased ``@pipeline`` function name otherwise. ``total_runs`` is the total number of dispatches across all versions. ``schedule`` is the most recently created active schedule for the pipeline, or ``none`` when no active schedule exists.",
"properties": {
"createdAt": {
"format": "date-time",
"title": "Createdat",
"type": "string"
},
"description": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Description"
},
"id": {
"maxLength": 24,
"minLength": 24,
"pattern": "^[0-9a-fA-F]{24}$",
"title": "Id",
"type": "string"
},
"isActive": {
"title": "Isactive",
"type": "boolean"
},
"latestVersion": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "Latestversion"
},
"mode": {
"description": "Pipeline lifecycle mode.",
"enum": [
"draft",
"locked"
],
"title": "PipelineMode",
"type": "string"
},
"name": {
"title": "Name",
"type": "string"
},
"schedule": {
"anyOf": [
{
"description": "Active schedule summary surfaced on the pipeline list.",
"properties": {
"cronExpression": {
"title": "Cronexpression",
"type": "string"
},
"timezone": {
"title": "Timezone",
"type": "string"
}
},
"required": [
"cronExpression",
"timezone"
],
"title": "PipelineListSchedule",
"type": "object"
},
{
"type": "null"
}
]
},
"totalRuns": {
"default": 0,
"title": "Totalruns",
"type": "integer"
},
"updatedAt": {
"format": "date-time",
"title": "Updatedat",
"type": "string"
},
"userId": {
"title": "Userid",
"type": "string"
}
},
"required": [
"id",
"name",
"mode",
"isActive",
"userId",
"createdAt",
"updatedAt"
],
"title": "PipelineListItem",
"type": "object"
}
PipelineListItem
Properties¶
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| createdAt | string(date-time) | true | none | |
| description | any | false | none |
anyOf
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| » anonymous | string | false | none |
or
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| » anonymous | null | false | none |
continued
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| id | string | true | maxLength: 24 minLength: 24 minLength: 24 |
none |
| isActive | boolean | true | none | |
| latestVersion | any | false | none |
anyOf
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| » anonymous | integer | false | none |
or
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| » anonymous | null | false | none |
continued
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| mode | PipelineMode | true | Pipeline lifecycle mode. | |
| name | string | true | none | |
| schedule | any | false | none |
anyOf
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| » anonymous | PipelineListSchedule | false | Active schedule summary surfaced on the pipeline list. |
or
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| » anonymous | null | false | none |
continued
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| totalRuns | integer | false | none | |
| updatedAt | string(date-time) | true | none | |
| userId | string | true | none |
PipelineListSchedule
{
"description": "Active schedule summary surfaced on the pipeline list.",
"properties": {
"cronExpression": {
"title": "Cronexpression",
"type": "string"
},
"timezone": {
"title": "Timezone",
"type": "string"
}
},
"required": [
"cronExpression",
"timezone"
],
"title": "PipelineListSchedule",
"type": "object"
}
PipelineListSchedule
Properties¶
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| cronExpression | string | true | none | |
| timezone | string | true | none |
PipelineMode
{
"description": "Pipeline lifecycle mode.",
"enum": [
"draft",
"locked"
],
"title": "PipelineMode",
"type": "string"
}
PipelineMode
Properties¶
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| PipelineMode | string | false | Pipeline lifecycle mode. |
Enumerated Values¶
| Property | Value |
|---|---|
| PipelineMode | [draft, locked] |
PipelineSourceResponse
{
"description": "Full source code of an uploaded pipeline file. ``source`` is the raw text of the ``source.py`` asset stored in object storage at upload / re-upload time. it is identical to what the user originally uploaded, preserving comments, imports, and all task definitions — not just the ``@pipeline``-decorated function.",
"properties": {
"source": {
"title": "Source",
"type": "string"
}
},
"required": [
"source"
],
"title": "PipelineSourceResponse",
"type": "object"
}
PipelineSourceResponse
Properties¶
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| source | string | true | none |
PipelineVersionResponse
{
"description": "Response schema for a single pipeline version.",
"properties": {
"createdAt": {
"format": "date-time",
"title": "Createdat",
"type": "string"
},
"errorDetail": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Errordetail"
},
"pythonVersion": {
"title": "Pythonversion",
"type": "string"
},
"resourceBundle": {
"anyOf": [
{
"additionalProperties": true,
"type": "object"
},
{
"type": "null"
}
],
"title": "Resourcebundle"
},
"status": {
"description": "Status of a pipeline version.",
"enum": [
"PENDING",
"READY",
"FAILED"
],
"title": "PipelineVersionStatus",
"type": "string"
},
"taskNames": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Tasknames"
},
"version": {
"title": "Version",
"type": "integer"
}
},
"required": [
"version",
"status",
"pythonVersion",
"createdAt"
],
"title": "PipelineVersionResponse",
"type": "object"
}
PipelineVersionResponse
Properties¶
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| createdAt | string(date-time) | true | none | |
| errorDetail | any | false | none |
anyOf
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| » anonymous | string | false | none |
or
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| » anonymous | null | false | none |
continued
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| pythonVersion | string | true | none | |
| resourceBundle | any | false | none |
anyOf
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| » anonymous | object | false | none |
or
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| » anonymous | null | false | none |
continued
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| status | PipelineVersionStatus | true | Status of a pipeline version. | |
| taskNames | any | false | none |
anyOf
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| » anonymous | [string] | false | none |
or
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| » anonymous | null | false | none |
continued
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| version | integer | true | none |
PipelineVersionStatus
{
"description": "Status of a pipeline version.",
"enum": [
"PENDING",
"READY",
"FAILED"
],
"title": "PipelineVersionStatus",
"type": "string"
}
PipelineVersionStatus
Properties¶
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| PipelineVersionStatus | string | false | Status of a pipeline version. |
Enumerated Values¶
| Property | Value |
|---|---|
| PipelineVersionStatus | [PENDING, READY, FAILED] |
TaskParameter
{
"description": "A single parameter from a ``@task`` function signature.",
"properties": {
"annotation": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Annotation"
},
"name": {
"title": "Name",
"type": "string"
}
},
"required": [
"name"
],
"title": "TaskParameter",
"type": "object"
}
TaskParameter
Properties¶
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| annotation | any | false | none |
anyOf
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| » anonymous | string | false | none |
or
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| » anonymous | null | false | none |
continued
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| name | string | true | none |
TaskResponse
{
"description": "Response schema for a pipeline task detail endpoint.",
"properties": {
"id": {
"title": "Id",
"type": "integer"
},
"inputs": {
"anyOf": [
{
"additionalProperties": true,
"type": "object"
},
{
"type": "null"
}
],
"title": "Inputs"
},
"name": {
"title": "Name",
"type": "string"
},
"parameters": {
"items": {
"description": "A single parameter from a ``@task`` function signature.",
"properties": {
"annotation": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Annotation"
},
"name": {
"title": "Name",
"type": "string"
}
},
"required": [
"name"
],
"title": "TaskParameter",
"type": "object"
},
"title": "Parameters",
"type": "array"
},
"pipelineId": {
"maxLength": 24,
"minLength": 24,
"pattern": "^[0-9a-fA-F]{24}$",
"title": "Pipelineid",
"type": "string"
},
"resourceBundle": {
"anyOf": [
{
"additionalProperties": true,
"type": "object"
},
{
"type": "null"
}
],
"title": "Resourcebundle"
},
"resourceBundleId": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Resourcebundleid"
},
"source": {
"title": "Source",
"type": "string"
},
"taskGroupId": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "Taskgroupid"
},
"versionId": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "Versionid"
}
},
"required": [
"id",
"pipelineId",
"name",
"parameters",
"source"
],
"title": "TaskResponse",
"type": "object"
}
TaskResponse
Properties¶
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| id | integer | true | none | |
| inputs | any | false | none |
anyOf
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| » anonymous | object | false | none |
or
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| » anonymous | null | false | none |
continued
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| name | string | true | none | |
| parameters | [TaskParameter] | true | [A single parameter from a @task function signature.] |
|
| pipelineId | string | true | maxLength: 24 minLength: 24 minLength: 24 |
none |
| resourceBundle | any | false | none |
anyOf
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| » anonymous | object | false | none |
or
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| » anonymous | null | false | none |
continued
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| resourceBundleId | any | false | none |
anyOf
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| » anonymous | string | false | none |
or
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| » anonymous | null | false | none |
continued
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| source | string | true | none | |
| taskGroupId | any | false | none |
anyOf
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| » anonymous | integer | false | none |
or
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| » anonymous | null | false | none |
continued
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| versionId | any | false | none |
anyOf
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| » anonymous | integer | false | none |
or
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| » anonymous | null | false | none |
ValidationError
{
"properties": {
"ctx": {
"title": "Context",
"type": "object"
},
"input": {
"title": "Input"
},
"loc": {
"items": {
"anyOf": [
{
"type": "string"
},
{
"type": "integer"
}
]
},
"title": "Location",
"type": "array"
},
"msg": {
"title": "Message",
"type": "string"
},
"type": {
"title": "Error Type",
"type": "string"
}
},
"required": [
"loc",
"msg",
"type"
],
"title": "ValidationError",
"type": "object"
}
ValidationError
Properties¶
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| ctx | object | false | none | |
| input | any | false | none | |
| loc | [anyOf] | true | none |
anyOf
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| » anonymous | string | false | none |
or
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| » anonymous | integer | false | none |
continued
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| msg | string | true | none | |
| type | string | true | none |