Skip to content
GitmoapAPIBeta
Schema

SubmissionCapabilityInput

One capability in a submission. image_ref and image_digest point at your own registry; for a verified provider, gitmoap copies the image into its own registry.

Shape

  • capability_idCapabilityId (string)
  • descriptionstring
  • image_digeststring
  • image_refstring
  • namestring
  • stage_typeStageTypesourcebuildtestpublishdeploynotifycustomThe pipeline stage a capability belongs to. Maps verbatim to the stage_type field of a capability in gitmoap-provider.yaml.
  • bindablearray of PortName (string)optionalConfig keys that can take their value from an earlier step. Each becomes an optional value input port of the same name when the version is published.
  • cache_enabledbooleanoptional
  • config_schemaobjectoptional
  • default_timeout_secondsinteger · int32optional0–∞
  • input_groupsarray of PortGroupoptionalRules over which of the capability's optional inputs may be connected together.
    • 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.
  • inputsarray of PortDescriptoroptional
    • 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.
  • outputsarray of PortDescriptoroptional
    • 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_dockerbooleanoptional

Example

Synthesized example
{
"capability_id": "3b763e77-050d-4496-bda8-dcedcc109343",
"description": "Renders each region as density contours of its operations.",
"image_digest": "image-digest-f618",
"image_ref": "image-ref-7293",
"name": "payments-api",
"stage_type": "source",
"bindable": [
"bindable-372b",
"bindable-d811"
],
"cache_enabled": false,
"config_schema": {},
"default_timeout_seconds": 24,
"input_groups": [
{
"kind": "exactly_one_of",
"ports": []
},
{
"kind": "exactly_one_of",
"ports": []
}
],
"inputs": [
{
"name": "payments-api",
"port_type": "git_ref",
"required": false
},
{
"name": "payments-api",
"port_type": "git_ref",
"required": false
}
],
"outputs": [
{
"name": "payments-api",
"port_type": "git_ref",
"required": false
}
],
"requires_docker": false
}

Graph

Used by

Sent by 0 operations

No operation takes it as a request body.

Returned by 0 operations

No operation returns it directly.