Struct Example 

pub struct Example {
    pub summary: Option<String>,
    pub description: Option<String>,
    pub extensions: Extensions,
    /* private fields */
}

A worked example of a parameter, request body, response body or header.

Choosing a value field

OpenAPI 3.1 offers value and externalValue, which are mutually exclusive.

3.2 adds dataValue and serializedValue, and deprecates value for non-JSON serialization targets — for those, value has implementation-defined behaviour, which is exactly the kind of ambiguity Kynos avoids. Prefer data (the example as data, before serialization) and serialized (the example as it appears on the wire) whenever openapi32 is available and the target is not JSON.

The exclusions between those four fields are not a plain one-of, which is why they live in ExampleValue rather than in four Options.

Fields

summary: Option<String>

A short description of the example.

description: Option<String>

A long description of the example. CommonMark syntax may be used.

extensions: Extensions

Specification extensions.

Implementations

impl Example

pub fn new(value: impl Into<Value>) -> Self

Creates an example holding an embedded value.

pub fn external(uri: impl Into<String>) -> Self

Creates an example pointing at an external payload.

pub fn data(data: impl Into<Value>) -> Self

Creates an example given as data, before serialization.

Preferred over new whenever the serialization target is not JSON.

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

Creates an example given only in its serialized form.

pub fn data_serialized( data: impl Into<Value>, serialized: impl Into<String>, ) -> Self

Creates an example given as data together with its serialization.

The pair a boolean query parameter needs: true is the data, flag=true is what goes on the wire, and neither implies the other.

pub fn data_external(data: impl Into<Value>, uri: impl Into<String>) -> Self

Creates an example given as data, serialized into an external payload.

pub fn value(&self) -> Option<&ExampleValue>

The example this object carries, if it carries one.

An Example Object with only a summary is valid, if not useful.

pub fn with_summary(self, summary: impl Into<String>) -> Self

Sets the short summary.

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

Sets the long description.

Trait Implementations

impl Clone for Example

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Example

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

Formats the value using the given formatter.

impl Default for Example

fn default() -> Self

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for Example

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Eq for Example

impl PartialEq for Example

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

Equality operator ==.

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

Inequality operator !=.

impl Serialize for Example

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for Example