CapabilityDetailResponse

Shape

• cache_enabledboolean
• capability_idCapabilityId (string)
• config_schemaobjectThe JSON Schema a step's config must satisfy to use this capability.
• default_timeout_secondsinteger · int320–∞
• descriptionstring
• image_uristringThe container image that runs the capability, with an immutable version tag.
• inputsarray of PortDescriptor

  • The PortDescriptor schema
  • namePortName (string)
  • port_typePortTypegit_refartifactcontainer_imagetest_reportdeployment_refcredentialsevidencevaluecustomSemantic type of the data this port carries. Drives edge type-compatibility in the pipeline builder and validation/routing in the engine.
  • requiredboolean
  • cardinalityPortCardinalityonemanyoptionalHow many sources this input accepts. one by default; many takes several at once.
  • descriptionstring or nulloptionalWhat this port is for, in the provider's own words. Absent on a few older providers.
  • schema_idPortSchemaId (string) or nulloptionalFor a custom port, the id of the schema it carries (e.g. aws.ecs.task-definition/v1). Two custom ports connect only when their schema ids agree, or when either leaves this unset.
• namestring
• outputsarray of PortDescriptor

  • The PortDescriptor schema
  • namePortName (string)
  • port_typePortTypegit_refartifactcontainer_imagetest_reportdeployment_refcredentialsevidencevaluecustomSemantic type of the data this port carries. Drives edge type-compatibility in the pipeline builder and validation/routing in the engine.
  • requiredboolean
  • cardinalityPortCardinalityonemanyoptionalHow many sources this input accepts. one by default; many takes several at once.
  • descriptionstring or nulloptionalWhat this port is for, in the provider's own words. Absent on a few older providers.
  • schema_idPortSchemaId (string) or nulloptionalFor a custom port, the id of the schema it carries (e.g. aws.ecs.task-definition/v1). Two custom ports connect only when their schema ids agree, or when either leaves this unset.
• requires_dockerboolean
• stage_typeStageTypesourcebuildtestpublishdeploynotifycustomThe pipeline stage a capability belongs to. Maps verbatim to the stage_type field of a capability in gitmoap-provider.yaml.
• versionProviderVersion (string)
• bindablearray of PortName (string)optionalConfig keys that can take their value from an earlier step. Each has an optional value input port of the same name: connect it and read it with {"$from": "<key>"}, or leave it unconnected and write the value yourself.
• image_digeststring or nulloptionalThe exact build of the capability's container image, when the catalog records one. Pinned so a run cannot pick up a different build behind the same tag.
• input_groupsarray of PortGroupoptionalRules about which inputs are alternatives to each other. Empty for most capabilities.

  • The PortGroup schema
  • kindPortGroupKindexactly_one_ofat_most_one_ofat_least_one_ofHow many of a group's ports may be connected.
  • portsarray of PortName (string)The member input ports, in the order the author should read them.
  • descriptionstring or nulloptionalWhy these ports constrain each other, in the provider's own words. Rendered beside the group, and repeated in the validation error when the group is unsatisfied — which is the point: the sentence explaining the rule reaches the person who broke it.
• source_image_refstring or nulloptionalFor a verified provider, the image's location in its publisher's registry before gitmoap copied it. Absent for providers gitmoap builds itself.

Graph

Used by