Struct InteractionDescriptor 

#[non_exhaustive]
pub struct InteractionDescriptor {

    pub interaction_id: InteractionId,
    pub kind: InteractionKind,
    pub http_method: InteractionHttpMethod,
    pub label: String,
    pub required_action: Option<String>,
    pub input_schema: Option<SchemaContract>,
    pub result_schema: Option<SchemaContract>,
    pub sensitive_fields: Vec<String>,
    pub params: Vec<ParamFieldDescriptor>,
    pub timeout_seconds: Option<u16>,
    pub confirmation: Option<InteractionConfirmation>,
    pub transport: InteractionTransport,
    pub workflow_steps: Vec<WorkflowStepDescriptor>,
    pub form_ui: Option<FormUiDescriptor>,
    pub icon: Option<String>,
    pub submit_label: Option<String>,
    pub provider_invocable: bool,
}

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

interaction_id: InteractionId

kind: InteractionKind

http_method: InteractionHttpMethod

HTTP method this interaction is dispatched with. Wire default is POST (providers that predate the method model omit the field); DataLoads normalize to GET at admission regardless of the declared value.

label: String

required_action: Option<String>

Canonical action string (resource:verb) required to view/use this interaction; parsed to Action at admission.

input_schema: Option<SchemaContract>

result_schema: Option<SchemaContract>

sensitive_fields: Vec<String>

params: Vec<ParamFieldDescriptor>

Opt-in per-field param declarations (GET query typing + body validation).

timeout_seconds: Option<u16>

confirmation: Option<InteractionConfirmation>

transport: InteractionTransport

workflow_steps: Vec<WorkflowStepDescriptor>

form_ui: Option<FormUiDescriptor>

icon: Option<String>

submit_label: Option<String>

provider_invocable: bool

Allows same-tenant provider-origin (service-initiated) invocation of this interaction even when required_action is set. Fail-closed: absent on the wire deserializes to false. Honored only for Plugin/BuiltIn-registered interactions — see validate_for_provider. For Service-kind providers the flag is additionally rejected at surface-level admission when the home surface descriptor carries required_action (enforced in protocol.rs’s registration validation, not here).

Implementations

impl InteractionDescriptor

pub fn new( interaction_id: InteractionId, kind: InteractionKind, label: impl Into<String>, transport: InteractionTransport, ) -> InteractionDescriptor

Creates a new InteractionDescriptor with all optional fields set to their defaults.

pub fn with_http_method( self, http_method: InteractionHttpMethod, ) -> InteractionDescriptor

Declare a non-default dispatch method (PUT/DELETE mutations).

pub fn with_params( self, params: Vec<ParamFieldDescriptor>, ) -> InteractionDescriptor

Declare per-field param descriptors (GET query typing + body validation).

pub fn effective_http_method(&self) -> InteractionHttpMethod

The method the framework dispatches with: DataLoads are GET-only (B1); any other kind uses the declared method.

pub fn validate_for_provider( &self, provider_kind: ProviderKind, ) -> Result<(), InteractionValidationError>

Validates provider-specific interaction contract rules.

Errors

Returns InteractionValidationError::TimeoutOutOfRange when timeout_seconds falls outside MIN_INTERACTION_TIMEOUT_SECONDS..=MAX_INTERACTION_TIMEOUT_SECONDS. Returns InteractionValidationError::WorkflowMissingSteps when a workflow interaction declares no steps. Returns InteractionValidationError::ConfirmableActionMissingConfirmation when a confirmable interaction omits confirmation metadata. Returns InteractionValidationError::BlankLabel when label is empty or whitespace-only. Returns InteractionValidationError::BlankWorkflowStepLabel when any workflow step has an empty or whitespace-only label. Returns InteractionValidationError::IconInvalid when icon is Some but fails kebab-case validation. Returns InteractionValidationError::ProviderInvocableForbiddenForServiceProviders when a Service provider sets provider_invocable on an interaction that also declares required_action. The descriptor-level companion rule (rejecting provider_invocable when the surface descriptor carries required_action) lives in protocol.rs::validate_descriptor_gated_provider_invocable, because this method never sees the surface descriptor.

Trait Implementations

impl Clone for InteractionDescriptor

fn clone(&self) -> InteractionDescriptor

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for InteractionDescriptor

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for InteractionDescriptor

fn deserialize<__D>( __deserializer: __D, ) -> Result<InteractionDescriptor, <__D as Deserializer<'de>>::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Eq for InteractionDescriptor

impl PartialEq for InteractionDescriptor

fn eq(&self, other: &InteractionDescriptor) -> bool

Equality operator ==.

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=.

impl Serialize for InteractionDescriptor

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for InteractionDescriptor