Struct openapiv3::Example [−][src]
pub struct Example {
pub summary: Option<String>,
pub description: Option<String>,
pub value: Option<Value>,
pub external_value: Option<String>,
pub extensions: IndexMap<String, Value>,
}
Fields
summary: Option<String>
Short description for the example.
description: Option<String>
Long description for the example. CommonMark syntax MAY be used for rich text representation.
value: Option<Value>
Embedded literal example. The value
field and externalValue
field are mutually exclusive. To represent examples of
media types that cannot naturally represented in JSON or YAML,
use a string value to contain the example, escaping where necessary.
external_value: Option<String>
A URL that points to the literal example.
This provides the capability to reference examples that cannot
easily be included in JSON or YAML documents. The value
field and
externalValue
field are mutually exclusive.
extensions: IndexMap<String, Value>
Inline extensions to this object.
Trait Implementations
fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error> where
__D: Deserializer<'de>,
fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error> where
__D: Deserializer<'de>,
Deserialize this value from the given Serde deserializer. Read more
Auto Trait Implementations
impl RefUnwindSafe for Example
impl UnwindSafe for Example
Blanket Implementations
Mutably borrows from an owned value. Read more