Pipeline

A pipeline is a list of steps with a defined input and output. Pipelines can either be public or private. You can only call private pipelines by other pipelines in the same environment (trusted or regular).

Pipeline steps can have different types. See Step reference.

The following example shows the basic structure of a pipeline.

{
  "version": "1",
  "pipeline": {
    "id": "shopgate.testPipelines.doSth.v1",
    "public": true,
    "input": [
      { "key": "pipelineInput1", "id": "1" },
      { "key": "pipelineInput2", "id": "2", "optional": true }
    ],
    "output": [
      { "key": "pipelineOutput1", "id": "1" },
      { "key": "pipelineOutput2", "id": "10" },
      { "key": "pipelineOutput3", "id": "11", "optional": true }
    ],
    "steps": [{
      "type": "extension",
      "id": "@shopgate/testPipelines",
      "path": "@shopgate/testPipelines/someSteps/doSth.js",
      "input": [
        { "key": "input1", "id": "1" }],
      "output": [
        { "key": "output2", "id": "10" }
      ]
    }, {
      "type": "extension",
      "id": "@shopgate/crazyPipelines",
      "path": "@shopgate/crazyPipelines/greatSteps/doSthElse.js",
      "input": [
        { "key": "input2", "id": "2", "optional": true },
        { "key": "output2", "id": "10" }
      ],
      "output": [
        { "key": "output3", "id": "11", "optional": true }
      ]
    }]
  }
}