Struct openapi_type::OpenapiSchema

#[non_exhaustive]
pub struct OpenapiSchema {
    pub name: Option<String>,
    pub description: Option<String>,
    pub nullable: bool,
    pub schema: SchemaKind,
    pub dependencies: IndexMap<String, OpenapiSchema>,
}

This struct is used to generate the OpenAPI specification for a particular type. It is already made available for all primitives and some other types from the rust standard library, and you can also make your own types provide one through the OpenapiType trait and derive macro.

Note that this struct is marked non-exhaustive. This means that new attributes might be added at any point in time without a breaking change. The only way to obtain a value is through the OpenapiSchema::new method.

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

name: Option<String>

The name of this schema. If it is None, the schema will be inlined.

description: Option<String>

The description of this schema. Optional and only makes sense when a [name] is set as well.

nullable: bool

Whether this particular schema is nullable. Note that there is no guarantee that this will make it into the final specification, it might just be interpreted as a hint to make it an optional parameter.

schema: SchemaKind

The actual OpenAPI schema.

dependencies: IndexMap<String, OpenapiSchema>

Other schemas that this schema depends on. They will be included in the final OpenAPI Spec along with this schema.

Implementations

impl OpenapiSchema

pub fn new(schema: SchemaKind) -> Self

Create a new schema that has no name.

pub fn into_schema(self) -> Schema

Convert this schema to a Schema that can be serialized to the OpenAPI Spec.

Trait Implementations

impl Clone for OpenapiSchema

fn clone(&self) -> OpenapiSchema

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for OpenapiSchema

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

Formats the value using the given formatter.

impl PartialEq<OpenapiSchema> for OpenapiSchema

fn eq(&self, other: &OpenapiSchema) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &OpenapiSchema) -> bool

This method tests for !=.

impl StructuralPartialEq for OpenapiSchema