Struct Spec 

pub struct Spec { /* private fields */ }

High-level representation of a parsed and queryable OpenAPI spec.

Implementations

impl Spec

pub fn load(path: impl AsRef<Path>) -> Result<Self, ForgeError>

Load an OpenAPI spec from a YAML or JSON file.

Errors

Returns an error if the file cannot be read, parsed, or is not OpenAPI 3.0.x.

pub fn parse(content: &str) -> Result<Self, ForgeError>

Parse an OpenAPI spec from a string (YAML or JSON).

Convenience wrapper around the FromStr implementation.

Errors

Returns an error if the string cannot be parsed.

pub fn endpoints(&self) -> Vec<Endpoint>

Get all endpoints in the spec.

pub fn schema(&self, name: &str) -> Result<&SchemaObject, ForgeError>

Look up a component schema by name.

Errors

Returns SchemaNotFound if the schema name does not exist.

pub fn schema_names(&self) -> Vec<&str>

Get all component schema names.

pub fn fields(&self, schema_name: &str) -> Result<Vec<Field>, ForgeError>

Resolve fields from a named schema, including type info and required status.

Errors

Returns an error if the schema is not found.

pub fn resolve_type(&self, schema: &SchemaObject) -> TypeInfo

Resolve the type info for a sekkei Schema.

Delegates to takumi::schema_to_field_type for consistent type resolution.

pub fn resolve_schema_or_ref_type( &self, schema_or_ref: &SchemaOrRef, ) -> TypeInfo

Resolve the type info for a SchemaOrRef adapter.

pub fn diff_schemas( &self, name_a: &str, name_b: &str, ) -> Result<SchemaDiff, ForgeError>

Diff two schemas by name, showing added/removed/changed fields.

Errors

Returns an error if either schema is not found.

pub fn group_by_crud_pattern(&self) -> Vec<CrudGroup>

Heuristic CRUD grouping of endpoints by operation pattern.

Groups endpoints like /create-secret, /get-secret-value, /update-secret-val, /delete-item into clusters by matching create/get/update/delete prefixes.

pub fn endpoint_by_path(&self, path: &str) -> Option<Endpoint>

Find an endpoint by its path.

Trait Implementations

impl Clone for Spec

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Spec

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

Formats the value using the given formatter.

impl FromStr for Spec

type Err = ForgeError

The associated error which can be returned from parsing.

fn from_str(s: &str) -> Result<Self, Self::Err>

Parses a string s to return a value of this type.