Struct schemars::visit::SetSingleExample

pub struct SetSingleExample {
    pub retain_examples: bool,
}

This visitor will remove the examples schema property and (if present) set its first value as the example property.

This is useful for dialects of JSON Schema (e.g. OpenAPI 3.0) that do not support the examples property.

Fields

retain_examples: bool

When set to true, the examples property will not be removed, but its first value will still be copied to example.

Trait Implementations

impl Clone for SetSingleExample

fn clone(&self) -> SetSingleExample

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for SetSingleExample

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

Formats the value using the given formatter.

impl Visitor for SetSingleExample

fn visit_schema_object(&mut self, schema: &mut SchemaObject)

Override this method to modify a SchemaObject and (optionally) its subschemas.

fn visit_root_schema(&mut self, root: &mut RootSchema)

Override this method to modify a RootSchema and (optionally) its subschemas.

fn visit_schema(&mut self, schema: &mut Schema)

Override this method to modify a Schema and (optionally) its subschemas.