ParamSpec
What a manual trigger may be asked for: one declared parameter.
Shape
- nameParamName (string)How the parameter is addressed — in the trigger request body, and as the tail of a
{"$context": "params.<name>"}reference. - defaultobjectoptionalUsed when the caller supplies nothing.
- descriptionstring or nulloptionalShown next to the field when a person starts the run.
- optionsarray of stringoptionalWhen non-empty, the only values accepted — a fixed choice rather than free text. Applies to
stringparameters; values are compared exactly. - requiredbooleanoptionalWhether a run may start without it. A required parameter with a
defaultis satisfied by that default, so the two are not in conflict. - typeParamTypestringnumberbooleanoptionalThe type a supplied value must have:
string(the default),numberorboolean.
Example
Synthesized example{
"name": "payments-api",
"default": {},
"description": "Renders each region as density contours of its operations.",
"options": [
"options-1fb9"
],
"required": false,
"type": "string"
}
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.