Skip to main content

SpecTransformer

Struct SpecTransformer 

Source
pub struct SpecTransformer;
Expand description

Transforms OpenAPI specifications into Aperture’s cached format

Implementations§

Source§

impl SpecTransformer

Source

pub const fn new() -> Self

Creates a new SpecTransformer instance

Source

pub fn transform_with_options( &self, spec: &OpenAPI, options: &TransformOptions, ) -> Result<CachedSpec, Error>

Transforms an OpenAPI specification into a cached representation using options

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

Source

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

Source

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

Source

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§

Source§

impl Default for SpecTransformer

Source§

fn default() -> Self

Returns the “default value” for a type. Read more

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> PolicyExt for T
where T: ?Sized,

Source§

fn and<P, B, E>(self, other: P) -> And<T, P>
where T: Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow only if self and other return Action::Follow. Read more
Source§

fn or<P, B, E>(self, other: P) -> Or<T, P>
where T: Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow if either self or other returns Action::Follow. Read more
Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

Source§

fn vzip(self) -> V

Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

impl<T> ErasedDestructor for T
where T: 'static,