Struct DocumentBuilder 

pub struct DocumentBuilder { /* private fields */ }

Collects operations and produces a document.

Operations are described against the builder’s shared SchemaRegistry so every named schema appears exactly once in components.schemas.

Implementations

impl DocumentBuilder

pub fn new(title: impl Into<String>, version: impl Into<String>) -> Self

Start a document.

pub fn description(self, description: impl Into<String>) -> Self

Set the API description.

pub fn registry(&mut self) -> &mut SchemaRegistry

Registry to describe operations against.

pub fn add_operation(&mut self, path: &str, method: HttpMethod, op: Operation)

Add an operation at path (siderite {param} template syntax).

Unnamed path parameters are named positionally from the template, and template parameters with no documented schema get a string schema so the document stays valid.

pub fn build(self) -> Result<OpenApi, OpenApiError>

Finish the document.

Errors

Returns the first structural error found (duplicate operations or operation ids, schema name conflicts).

Trait Implementations

impl Debug for DocumentBuilder

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

Formats the value using the given formatter.