SchemaObject

Struct SchemaObject 

Source
pub struct SchemaObject {
    pub title: Option<String>,
    pub description: Option<String>,
    pub data_type: Option<OpenApiDataType>,
    pub format: Option<FormatModifier>,
    pub nullable: Option<bool>,
    pub required: Option<RequiredSchemaFields>,
    pub properties: Option<SchemaProperties>,
    pub items: Option<ArrayItems>,
    pub enum_values: Option<EnumValues>,
    pub all_of: Option<AllOf>,
    pub one_of: Option<OneOf>,
}
Expand description

ex.1

type: object
required:
  - id
properties:
  id:
    type: integer
    format: int64
  tag:
    type: string

ex.2

type: integer
format: int64

ex.3

type: array
items:
    type: string

ex.4

type: string
enum:
  - "value1"
  - "value2"

ex.5

allOf:
  - $ref: '#/components/schemas/BasicErrorModel'
  - type: object
    required:
      - rootCause
    properties:
      rootCause:
        type: string

ex.6

oneOf:
  - $ref: '#/components/schemas/Cat'
  - $ref: '#/components/schemas/Dog'

rf. https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.0.3.md#schema-object

Fields§

§title: Option<String>§description: Option<String>§data_type: Option<OpenApiDataType>

type - Value MUST be a string. Multiple types via an array are not supported.

§format: Option<FormatModifier>§nullable: Option<bool>

rf. https://swagger.io/docs/specification/data-models/data-types/

§required: Option<RequiredSchemaFields>§properties: Option<SchemaProperties>§items: Option<ArrayItems>§enum_values: Option<EnumValues>§all_of: Option<AllOf>§one_of: Option<OneOf>

Implementations§

Trait Implementations§

Source§

impl Clone for SchemaObject

Source§

fn clone(&self) -> SchemaObject

Returns a duplicate of the value. Read more
1.0.0 · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for SchemaObject

Source§

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

Formats the value using the given formatter. Read more
Source§

impl From<SchemaObject> for SchemaCase

Source§

fn from(this: SchemaObject) -> Self

Converts to this type from the input type.

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.