Enum utoipa::openapi::schema::Schema

#[non_exhaustive]
pub enum Schema {
    Object(Object),
    Array(Array),
    OneOf(OneOf),
}

Is super type for OpenAPI Schema Object. Schema is reusable resource what can be referenced from path operations and other components using Ref.

Variants (Non-exhaustive)

Non-exhaustive enums could have additional variants added in future. Therefore, when matching against variants of non-exhaustive enums, an extra wildcard arm must be added to account for any future variants.

Object(Object)

Defines object schema. Object is either object hodling properties which are other Schemas or can be a field within the Object.

Array(Array)

Defines array schema from another schema. Typically used with Schema::Object. Slice and Vec types are translated to Schema::Array types.

OneOf(OneOf)

Creates a OneOf type Discriminator Object schema. This schema is used to map multiple schemas together where API endpoint could return any of them. Schema::OneOf is created form complex enum where enum holds other than unit types.

Trait Implementations

impl Clone for Schema

fn clone(&self) -> Schema

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Default for Schema

fn default() -> Self

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for Schema

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error> where
    __D: Deserializer<'de>, 

Deserialize this value from the given Serde deserializer.

impl From<Array> for Schema

fn from(array: Array) -> Self

Converts to this type from the input type.

impl From<ArrayBuilder> for Schema

fn from(builder: ArrayBuilder) -> Self

Converts to this type from the input type.

impl From<Object> for Schema

fn from(s: Object) -> Self

Converts to this type from the input type.

impl From<ObjectBuilder> for Schema

fn from(builder: ObjectBuilder) -> Self

Converts to this type from the input type.

impl From<OneOf> for Schema

fn from(one_of: OneOf) -> Self

Converts to this type from the input type.

impl From<OneOfBuilder> for Schema

fn from(builder: OneOfBuilder) -> Self

Converts to this type from the input type.

impl Serialize for Schema

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error> where
    __S: Serializer, 

Serialize this value into the given Serde serializer.