Skip to main content

Module contract

Module contract 

Source
Expand description

Build-time contract normalization and registry helpers.

Structs§

ContractRegistry
Normalized contract registry used by code generation and verification tests.
GeneratedArtifacts
Build-time artifacts produced from the normalized FerrisKey contract.
OperationDescriptorSeed
Operation descriptor seed before rendering the generated metadata module.
ParameterDescriptorSeed
Parameter descriptor seed before rendering the generated metadata module.
RequestBodyDescriptorSeed
Request-body descriptor seed before rendering the generated metadata module.
ResponseDescriptorSeed
Response descriptor seed before rendering the generated metadata module.

Enums§

ContractError
Errors raised while normalizing or generating FerrisKey contract artifacts.
ParameterLocationSeed
Supported OpenAPI parameter locations during registry generation.

Functions§

build_registry
Build a contract registry from a normalized OpenAPI document.
generate_artifacts
Generate normalized contract artifacts and the in-memory registry.
load_contract
Load a JSON contract document from disk.
normalize_contract
Normalize the FerrisKey OpenAPI document for generation and Prism use.
normalized_contract_path
Resolve the normalized Prism contract path from a crate manifest directory.
render_generated_module
Render the generated Rust metadata module for the normalized contract registry.
source_contract_path
Resolve the source FerrisKey contract path from a crate manifest directory.