Struct ResolveOptions 

pub struct ResolveOptions {
    pub direction: Direction,
    pub operation: String,
    pub strict: bool,
    pub include_future: bool,
    pub def_name: Option<String>,
}

Options for schema resolution.

Fields

direction: Direction

Whether resolving for request or response.

operation: String

The operation to resolve for (e.g., “create”, “update”). Will be normalized to lowercase.

strict: bool

When true, sets additionalProperties: false on all object schemas to reject unknown fields. Defaults to false to respect schema extensibility.

include_future: bool

When true, includes fields with omit visibility that have a transition targeting a non-omit value (i.e., planned additions). These fields appear in the resolved output with x-ucp-schema-transition metadata but are NOT added to required. Completes the lifecycle symmetry: deprecations (to=omit) are always surfaced; this flag surfaces planned additions (from=omit) too.

def_name: Option<String>

Explicit $defs entry to select as the validation/output target, overriding the {op}_{direction} derivation used for container capabilities. Names non-derivable shapes that aren’t an operation + direction — transport message types (error_response), host views (business_schema), and sub-types of single-object schemas (cart → checkout). When set, selection ignores the container check so it works on schemas that also have a root body.

Implementations

impl ResolveOptions

pub fn new(direction: Direction, operation: impl Into<String>) -> Self

Create new resolve options with strict mode disabled (default).

Operation is normalized to lowercase for case-insensitive matching. Strict mode is off by default to respect UCP’s extensibility model: schemas validate known fields but allow additional properties.

pub fn strict(self, strict: bool) -> Self

Set strict mode (additionalProperties: false on all objects).

pub fn include_future(self, include_future: bool) -> Self

Include future fields (omit-visibility with non-omit transition target).

pub fn def_name(self, def_name: Option<String>) -> Self

Select an explicit $defs entry, overriding {op}_{direction} derivation (see Self::def_name).

Trait Implementations

impl Clone for ResolveOptions

fn clone(&self) -> ResolveOptions

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ResolveOptions

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

Formats the value using the given formatter.