Skip to Content
OpenETL
ReferenceAPIApply Service

Apply

Stores each definition as an immutable version; unchanged definitions keep theirs. A pipeline's version pins the versions of its source and destination and its dbt projects' bundles. Either every document applies or none does.

POST
/v1/workspaces/{workspace}:apply

Stores each definition as an immutable version; unchanged definitions keep theirs. A pipeline's version pins the versions of its source and destination and its dbt projects' bundles. Either every document applies or none does.

Path Parameters

workspace*string

The workspace id.

Request Body

application/json
  1. body
workspace?string

workspaces/{workspace}, for documents that don't name one.

documents?array<>
validateOnly?boolean
client?string

What's applying, such as "cli", for connector versions' provenance. Empty: "api".

transfer?array<string>

Connector packages, by name, whose versions may come from another repository than their earlier versions.

Response Body

OK

application/json
  1. response
resources?array<>

One per document, in order.

dependents?array<>

Pipelines the documents don't define, which have a new version because a source, destination or dbt project they use changed.

plans?array<>

One per pipeline in resources, then one per dependent.

Example Request
curl -X POST 'http://localhost:8080/v1/workspaces/string:apply' \  -H 'Content-Type: application/json' \  -d '{}'
Example Response
{  "resources": [    {      "kind": "string",      "name": "string",      "action": "APPLY_ACTION_UNSPECIFIED",      "version": "string"    }  ],  "dependents": [    {      "kind": "string",      "name": "string",      "action": "APPLY_ACTION_UNSPECIFIED",      "version": "string"    }  ],  "plans": [    {      "pipeline": "string",      "version": "string",      "changes": [        {          "field": "string",          "before": "string",          "after": "string"        }      ],      "streams": [        {          "name": "string",          "level": "DELIVERY_LEVEL_UNSPECIFIED",          "dedupe": true,          "reason": "string",          "collapse": true,          "write": "WRITE_MODE_UNSPECIFIED",          "typeChanges": true,          "paused": true,          "table": "string"        }      ],      "problems": [        "string"      ],      "notes": [        "string"      ],      "warnings": [        {          "stream": "string",          "message": "string"        }      ],      "job": {        "size": {          "preset": "string",          "cpuMillis": "string",          "memoryBytes": "string"        },        "reason": "JOB_SIZE_REASON_UNSPECIFIED",        "pool": "string"      },      "overrides": [        {          "field": "string",          "value": "string",          "specValue": "string",          "reason": "string",          "incident": "string",          "updateTime": "2019-08-24T14:15:22Z"        }      ]    }  ]}