Structure

CustomActionParameter

A declared parameter on a CustomActionConfig.

struct CustomActionParameter

Overview

Used for validation (required vs. defaulted), defaulting, and surfacing the shape of custom actions to AI agents via shipit ai-session.

var defaultValue: JSONValue?
Fallback value applied when the call site omits the parameter.
var description: String?
Optional human-readable description.
var isRequired: Bool
The parameter is required when explicitly marked required or no default value was supplied.
var required: Bool?
Whether the parameter must be supplied at the call site. Defaults to true when no defaultValue is set, otherwise false.
var type: String?
Value kind: "string" (default), "bool", "int", "number", "array", or "any".