Struct openapi_type::OpenapiSchema

pub struct OpenapiSchema {
    pub name: Option<String>,
    pub nullable: bool,
    pub schema: SchemaKind,
    pub dependencies: IndexMap<String, OpenapiSchema>,
}

This struct needs to be available for every type that can be part of an OpenAPI Spec. It is already implemented for primitive types, String, Vec, Option and the like. To have it available for your type, simply derive from OpenapiType.

Fields

name: Option<String>

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

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