ComponentParameter
A typed value a consuming pipeline supplies.
Shape
- 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.
Example
Synthesized example{
"name": "payments-api",
"param_type": "string",
"allowed_values": [
{},
{}
],
"default": {},
"description": "Renders each region as density contours of its operations.",
"required": false
}
Graph
Used inside
Contains
No named schema inside.
Used by
Sent by 0 operations
No operation takes it as a request body.
Returned by 0 operations
No operation returns it directly.