[−]Struct rweb::openapi::Schema
The Schema Object allows the definition of input and output data types. These types can be objects, but also primitives and arrays. This object is an extended subset of the JSON Schema Specification Wright Draft 00. For more information about the properties, see JSON Schema Core and JSON Schema Validation. Unless stated otherwise, the property definitions follow the JSON Schema.
See https://github.com/OAI/OpenAPI-Specification/blob/master/versions/3.0.1.md#schemaObject.
Fields
ref_path: Cow<'static, str>
JSON reference path to another definition
description: Cow<'static, str>
schema_type: Option<Type>
format: Cow<'static, str>
enum_values: Vec<Cow<'static, str>>
required: Vec<Cow<'static, str>>
items: Option<Box<Schema>>
properties: BTreeMap<Cow<'static, str>, Schema>
read_only: Option<bool>
nullable: Option<bool>
additional_properties: Option<ObjectOrReference<Box<Schema>>>
Value can be boolean or object. Inline or referenced schema MUST be of a Schema Object and not a standard JSON Schema.
See https://github.com/OAI/OpenAPI-Specification/blob/master/versions/3.0.1.md#properties.
example: Option<Value>
A free-form property to include an example of an instance for this schema.
To represent examples that cannot be naturally represented in JSON or YAML,
a string value can be used to contain the example with escaping where necessary.
NOTE: According to spec, Primitive data types in the OAS are based on the
types supported by the JSON Schema Specification Wright Draft 00.
This suggest using
serde_json::Value
. [spec][https://github.com/OAI/OpenAPI-Specification/blob/master/versions/3.0.1.md#data-types]
title: Cow<'static, str>
default: Option<Value>
The default value represents what would be assumed by the consumer of the input as the value
of the schema if one is not provided. Unlike JSON Schema, the value MUST conform to the
defined type for the Schema Object defined at the same level. For example, if type is
string
, then default
can be "foo"
but cannot be 1
.
minimum: Option<Value>
all_of: Vec<ObjectOrReference<Schema>>
Inline or referenced schema MUST be of a Schema Object and not a standard JSON Schema.
one_of: Vec<ObjectOrReference<Schema>>
Inline or referenced schema MUST be of a Schema Object and not a standard JSON Schema.
Trait Implementations
impl Clone for Schema
fn clone(&self) -> Schema
fn clone_from(&mut self, source: &Self)
1.0.0[src]
impl Debug for Schema
impl Default for Schema
impl<'de> Deserialize<'de> for Schema
fn deserialize<__D>(
__deserializer: __D
) -> Result<Schema, <__D as Deserializer<'de>>::Error> where
__D: Deserializer<'de>,
__deserializer: __D
) -> Result<Schema, <__D as Deserializer<'de>>::Error> where
__D: Deserializer<'de>,
impl PartialEq<Schema> for Schema
impl Serialize for Schema
fn serialize<__S>(
&self,
__serializer: __S
) -> Result<<__S as Serializer>::Ok, <__S as Serializer>::Error> where
__S: Serializer,
&self,
__serializer: __S
) -> Result<<__S as Serializer>::Ok, <__S as Serializer>::Error> where
__S: Serializer,
impl StructuralPartialEq for Schema
Auto Trait Implementations
impl RefUnwindSafe for Schema
impl Send for Schema
impl Sync for Schema
impl Unpin for Schema
impl UnwindSafe for Schema
Blanket Implementations
impl<T> Any for T where
T: 'static + ?Sized,
[src]
T: 'static + ?Sized,
impl<T> Borrow<T> for T where
T: ?Sized,
[src]
T: ?Sized,
impl<T> BorrowMut<T> for T where
T: ?Sized,
[src]
T: ?Sized,
fn borrow_mut(&mut self) -> &mut T
[src]
impl<T> DeserializeOwned for T where
T: Deserialize<'de>,
[src]
T: Deserialize<'de>,
impl<T> From<T> for T
[src]
impl<T, U> Into<U> for T where
U: From<T>,
[src]
U: From<T>,
impl<T> Same<T> for T
type Output = T
Should always be Self
impl<T> ToOwned for T where
T: Clone,
[src]
T: Clone,
type Owned = T
The resulting type after obtaining ownership.
fn to_owned(&self) -> T
[src]
fn clone_into(&self, target: &mut T)
[src]
impl<T, U> TryFrom<U> for T where
U: Into<T>,
[src]
U: Into<T>,
type Error = Infallible
The type returned in the event of a conversion error.
fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>
[src]
impl<T, U> TryInto<U> for T where
U: TryFrom<T>,
[src]
U: TryFrom<T>,
type Error = <U as TryFrom<T>>::Error
The type returned in the event of a conversion error.
fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>
[src]
impl<V, T> VZip<V> for T where
V: MultiLane<T>,
V: MultiLane<T>,