Struct ParamSpec 

pub struct ParamSpec {
    pub kind: ParamType,
    pub required: bool,
    pub default: Option<Value>,
    pub secret: bool,
    pub description: Option<String>,
    pub computed: Option<String>,
}

One declared parameter.

Fields

kind: ParamType

Value type. Governs coercion of the supplied value and the type substituted when ${param.NAME} is a config value’s entire text.

required: bool

When true the caller MUST supply a value; there is no fallback. Mutually exclusive with default (a defaulted param is by definition optional).

default: Option<Value>

Value used when the caller supplies none. Resolved like any other config scalar first, so default: "${env:SINCE}" works.

secret: bool

Marks the value as sensitive: it is registered with the redaction registry the moment it is bound, so it never reaches logs, error strings, API responses, or the audit log in clear.

description: Option<String>

Human-readable purpose, surfaced by faucet template list/show, the MCP get_template tool, and GET /v1/templates/{id}.

computed: Option<String>

A derived value: this param is not user-supplied but computed from other params via an interpolation expression — ${param.NAME} and the ${map:NAME|case=value|*=default} lookup — resolved after the ordinary params bind (#573). A computed param is excluded from the trigger surface (supplying a value for it is an error) and is mutually exclusive with required, default, and secret. Example: accounts_domain: { computed: "${map:region|ca=zohocloud|*=zoho}" }.

Trait Implementations

impl Clone for ParamSpec

fn clone(&self) -> ParamSpec

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for ParamSpec

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for ParamSpec

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl JsonSchema for ParamSpec

fn schema_name() -> Cow<'static, str>

The name of the generated JSON Schema.

fn schema_id() -> Cow<'static, str>

Returns a string that uniquely identifies the schema produced by this type.

fn json_schema(generator: &mut SchemaGenerator) -> Schema

Generates a JSON Schema for this type.

fn inline_schema() -> bool

Whether JSON Schemas generated for this type should be included directly in parent schemas, rather than being re-used where possible using the $ref keyword.

impl Serialize for ParamSpec

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.