Struct ParameterSchema 

pub struct ParameterSchema {
    pub schema_type: SchemaType,
    pub description: Option<String>,
    pub properties: Option<IndexMap<String, ParameterSchema>>,
    pub items: Option<Box<ParameterSchema>>,
    pub required: Option<Vec<String>>,
    pub enum_values: Option<Vec<String>>,
}

Fields

schema_type: SchemaType

description: Option<String>

properties: Option<IndexMap<String, ParameterSchema>>

items: Option<Box<ParameterSchema>>

required: Option<Vec<String>>

enum_values: Option<Vec<String>>

Implementations

impl ParameterSchema

pub fn string(description: impl Into<String>) -> Self

pub fn integer(description: impl Into<String>) -> Self

pub fn number(description: impl Into<String>) -> Self

pub fn boolean(description: impl Into<String>) -> Self

pub fn string_enum( description: impl Into<String>, values: impl IntoIterator<Item = impl Into<String>>, ) -> Self

pub fn array(items: ParameterSchema) -> Self

pub fn object() -> Self

pub fn with_description(self, desc: impl Into<String>) -> Self

pub fn with_property( self, name: impl Into<String>, schema: ParameterSchema, ) -> Self

pub fn with_required( self, fields: impl IntoIterator<Item = impl Into<String>>, ) -> Self

Trait Implementations

impl Clone for ParameterSchema

fn clone(&self) -> ParameterSchema

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ParameterSchema

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for ParameterSchema

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Serialize for ParameterSchema

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

where __S: Serializer,

Serialize this value into the given Serde serializer.