Struct SpecTransformer

pub struct SpecTransformer;

Transforms OpenAPI specifications into Aperture’s cached format

Implementations

impl SpecTransformer

pub const fn new() -> Self

Creates a new SpecTransformer instance

pub fn transform(&self, name: &str, spec: &OpenAPI) -> Result<CachedSpec, Error>

Transforms an OpenAPI specification into a cached representation

This method converts the full OpenAPI spec into an optimized format that can be quickly loaded and used for CLI generation.

Errors

Returns an error if parameter reference resolution fails

pub fn transform_with_filter( &self, name: &str, spec: &OpenAPI, skip_endpoints: &[(String, String)], ) -> Result<CachedSpec, Error>

Transforms an OpenAPI specification into a cached representation with endpoint filtering

This method converts the full OpenAPI spec into an optimized format that can be quickly loaded and used for CLI generation, filtering out specified endpoints.

Arguments

• name - The name for the cached spec
• spec - The OpenAPI specification to transform
• skip_endpoints - List of endpoints to skip (path, method pairs)

Errors

Returns an error if parameter reference resolution fails

pub fn transform_with_warnings( &self, name: &str, spec: &OpenAPI, skip_endpoints: &[(String, String)], warnings: &[ValidationWarning], ) -> Result<CachedSpec, Error>

Transforms an OpenAPI specification with full warning information

Arguments

• name - The name for the cached spec
• spec - The OpenAPI specification to transform
• skip_endpoints - List of endpoints to skip (path, method pairs)
• warnings - Validation warnings to store in the cached spec

Errors

Returns an error if parameter reference resolution fails

Trait Implementations

impl Default for SpecTransformer

fn default() -> Self

Returns the “default value” for a type.