Skip to content
GitmoapAPIBeta
Schema

ComponentInstance

A component used in a pipeline. It acts like a step: connections reach it through the component's ports, and it expands into the component's steps.

Shape

  • component_idComponentId (string · uuid)The component used, by id. Creating another component with the same name later never changes what this instance runs.
  • idNodeId (string)The instance's id, unique among the pipeline's step ids. Connections use it as they use a step id.
  • namestringDisplay name, also put in front of the display names of the steps it expands into.
  • versionComponentVersionRef (string)
  • component_refstring or nulloptionalThe reference as the author wrote it, kept for display. It is not used to find the component.
  • paramsobjectoptionalValues for the component's parameters, by parameter name.
  • stage_mapobjectoptionalMaps every stage slot the component declares to a stage of this pipeline, keeping the slots' order.

Example

Synthesized example
{
"component_id": "bb8aa058-a57b-48c0-9400-0c5ac10dbbb1",
"id": "id-9331",
"name": "payments-api",
"version": "version-cc34",
"component_ref": "component-ref-55b8",
"params": {},
"stage_map": {
"stage_map": "stage-map-8f54"
}
}

Graph

Used inside
Contains

No named schema inside.

Used by

Sent by 0 operations

No operation takes it as a request body.

Returned by 4 operations