Enum Schema 

pub enum Schema {
    Ref {
        ref_path: String,
    },
    Object(ObjectType),
    Array(ArrayType),
    Primitive(PrimitiveSchema),
}

Schema definition, supports reference, object, array, and primitive types

• Ref: references a Schema defined in components.schemas via $ref
• Object: object type, contains properties and required
• Array: array type, contains items
• Primitive: primitive type (string/integer/number/boolean)

Variants

Ref

References another already-defined Schema

Fields

ref_path: String

Object(ObjectType)

Object type

Array(ArrayType)

Array type

Primitive(PrimitiveSchema)

Primitive type (string/integer/number/boolean)

Implementations

impl Schema

pub fn ref_to(name: &str) -> Self

Creates a reference Schema

pub fn object(obj: ObjectType) -> Self

Creates an object Schema

pub fn array(arr: ArrayType) -> Self

Creates an array Schema

pub fn string() -> Self

Creates a string Schema

pub fn integer() -> Self

Creates an integer Schema

pub fn number() -> Self

Creates a number Schema

pub fn boolean() -> Self

Creates a boolean Schema

pub fn is_ref(&self) -> bool

Determines whether it is a reference type

pub fn is_object(&self) -> bool

Determines whether it is an object type

pub fn is_array(&self) -> bool

Determines whether it is an array type

pub fn with_format(self, format: &str) -> Self

Sets the format (only effective for Primitive types; other types return the original value)

pub fn with_description(self, desc: &str) -> Self

Sets the description (only effective for Primitive types)

pub fn with_example(self, value: Value) -> Self

Sets the example value (only effective for Primitive types)

pub fn with_default(self, value: Value) -> Self

Sets the default value (only effective for Primitive types)

Trait Implementations

impl Clone for Schema

fn clone(&self) -> Schema

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Schema

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

Formats the value using the given formatter.

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 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.