Skip to content
GitmoapAPIBeta
Schema

PortGroup

A rule about how many of a capability's inputs may be connected together — which of them are alternatives, and whether one is required.

Shape

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

Example

Synthesized example
{
"kind": "exactly_one_of",
"ports": [
"ports-f9de",
"ports-2181"
],
"description": "Renders each region as density contours of its operations."
}

Graph

Contains

No named schema inside.

Used by

Sent by 0 operations

No operation takes it as a request body.