Skip to content
GitmoapAPIBeta
Schema

PortDescriptor

One input or output of a capability — what it carries, whether it is required, and what it is for.

Shape

  • 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.

Example

Synthesized example
{
"name": "payments-api",
"port_type": "git_ref",
"required": false,
"cardinality": "one",
"description": "Renders each region as density contours of its operations.",
"schema_id": "b8d378f4-5daf-4d3f-a838-cce1437a2bd0"
}

Graph

Contains

No named schema inside.

Used by

Sent by 0 operations

No operation takes it as a request body.