Enum rweb::openapi::ParameterExamples

pub enum ParameterExamples {
    One {
        example: Option<Value>,
    },
    Multiple {
        examples: IndexMap<Cow<'static, str>, ObjectOrReference<Example>, RandomState>,
    },
}

Example(s) of the parameter’s potential value

Variants

One

Fields of One

example: Option<Value>

Example of the parameter’s potential value. The example SHOULD match the specified schema and encoding properties if present. The example field is mutually exclusive of the examples field. Furthermore, if referencing a schema that contains an example, the example value SHALL override the example provided by the schema. To represent examples of media types that cannot naturally be represented in JSON or YAML, a string value can contain the example with escaping where necessary.

Multiple

Fields of Multiple

examples: IndexMap<Cow<'static, str>, ObjectOrReference<Example>, RandomState>

Examples of the parameter’s potential value. Each example SHOULD contain a value in the correct format as specified in the parameter encoding. The examples field is mutually exclusive of the example field. Furthermore, if referencing a schema that contains an example, the examples value SHALL override the example provided by the schema.

Trait Implementations

impl Clone for ParameterExamples

pub fn clone(&self) -> ParameterExamples

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for ParameterExamples

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for ParameterExamples

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

Deserialize this value from the given Serde deserializer.

impl PartialEq<ParameterExamples> for ParameterExamples

pub fn eq(&self, other: &ParameterExamples) -> bool

This method tests for self and other values to be equal, and is used by ==.

pub fn ne(&self, other: &ParameterExamples) -> bool

This method tests for !=.

impl Serialize for ParameterExamples

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

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for ParameterExamples