ListPipelineComponentsResponse

Shape

• itemsarray of ComponentListItem

  • The ComponentListItem schema
  • bodyComponentBodyThe draft: what the next published version will contain.

    • The ComponentBody schema
    • component_instancesarray of NestedComponentInstanceoptionalOther components this component uses. Always empty in a published version, where they have already been expanded into steps.

      • The NestedComponentInstance schema
      • component_idComponentId (string · uuid)
      • idNodeId (string)
      • namestring
      • versionComponentVersionRef (string)
      • component_refstring or nulloptional
      • paramsobjectoptional
      • stage_mapobjectoptionalBinds every slot the referenced component declares to a slot of the containing body.
    • edgesarray of EdgeoptionalConnections between the component's own steps; both ends must be steps of this component.

      • The Edge schema
      • idEdgeId (string)
      • source_node_idNodeId (string)
      • target_node_idNodeId (string)
      • source_portPortName (string) or nulloptionalAbsent on a dependency-only edge.
      • target_portPortName (string) or nulloptionalAbsent on a dependency-only edge.
    • inputsarray of ComponentInputPortoptional

      • The ComponentInputPort schema
      • namePortName (string)
      • targetsarray of PortRef
      • descriptionstring or nulloptional
    • nodesarray of ComponentNodeoptional

      • The ComponentNode schema
      • nodeNode
      • stage_slotStageSlot (string)Which of the component's stage slots this step is placed in.
      • param_slotsComponentNodeParamsoptionalStep fields whose values come from the component's parameters rather than from the step.
    • outputsarray of ComponentOutputPortoptional

      • The ComponentOutputPort schema
      • namePortName (string)
      • sourcePortRef
      • descriptionstring or nulloptional
    • parametersarray of ComponentParameteroptional

      • The ComponentParameter schema
      • nameComponentParamName (string)
      • param_typeComponentParamTypestringnumberbooleanobjectarrayThe JSON shape a parameter's value must have.
      • allowed_valuesarray of object or nulloptionalThe only values this parameter accepts. Absent means any value of its type. On a published parameter, adding this list or removing a value from it is a major version change; adding a value is a minor one.
      • defaultobjectoptional
      • descriptionstring or nulloptional
      • requiredbooleanoptionalWhether a pipeline using the component must supply a value. A required parameter cannot have a default.
    • stage_slotsarray of StageSlot (string)optionalThe positions the component's steps occupy, in order. A pipeline using the component maps each slot to one of its own stages.
  • created_atstring
  • created_byActorSummary

    • The ActorSummary schema
    • emailstring
    • idstring
    • usernamestring
    • avatar_urlstring or nulloptional
  • idComponentId (string · uuid)
  • inheritedbooleanWhether the component belongs to a group above the group or repository being listed, rather than to it.
  • nameComponentName (string)
  • scopeScopeRef
  • updated_atstring
  • version_countinteger · int640–∞
  • descriptionstring or nulloptional
  • diagnosticsValidationSummary or nulloptionalProblems found in the draft. A draft is saved even when it is invalid.

    • The ValidationSummary schema
    • validboolean
    • violationsarray of ValidationViolation

      • The ValidationViolation schema
      • codestringStable machine-readable code (e.g. cycle_detected, type_mismatch, required_input_not_wired).
      • messagestringHuman-readable description.
      • targetValidationTarget
    • warningsarray of ValidationWarningoptionalThings worth knowing that do not make the definition invalid, such as a deprecated component version. A violation stops a published definition from being saved; a warning never does. Left out when there are none.

      • The ValidationWarning schema
      • codestringStable machine code — the warning rule's own name, exactly as a violation's is.
      • messagestring
      • targetValidationTarget
  • latest_versionComponentVersion (string) or nulloptional
  • unsatisfied_capabilitiesarray of CapabilityId (string)optionalCapabilities the latest active version needs that no provider installed here supplies. Left out when there are none.
  • versionsarray of ComponentVersionSummaryoptionalPublished versions, newest first. Present on a single-component read.

    • The ComponentVersionSummary schema
    • capability_requirementsarray of CapabilityId (string)The provider capabilities the version's steps use.
    • contract_digeststringA SHA-256 fingerprint, in hex, of what a pipeline using the version must satisfy: its parameters, its ports and the variables it reads. It changes only when that contract does.
    • depthinteger · int320–∞How many levels of components the version spans: 1 when it uses no other component.
    • expanded_node_countinteger · int320–∞How many steps the version expands into.
    • lifecycle_stateComponentLifecycleStateactivedeprecatedsunsetWhere a published version sits in its retirement. A deprecated version still resolves for an exact reference and still runs, but no floating reference selects it — which is what makes deprecating the safe way to retire one. A sunset version refuses to resolve at all, exact reference included.
    • published_atstring
    • published_byActorSummary

      • The ActorSummary schema
      • emailstring
      • idstring
      • usernamestring
      • avatar_urlstring or nulloptional
    • variable_requirementsarray of EnvironmentVariableName (string)The variables the version's steps read from the pipeline that uses it. Each must be declared on the environment those steps run in, or on a group or repository above the pipeline, or a run is refused when it starts.
    • versionComponentVersion (string)
    • changelogstring or nulloptional
• next_tokenstring or nulloptional

Graph

Used by