Struct jsona_openapi_spec::ServerVariable

pub struct ServerVariable {
    pub default: String,
    pub substitutions_enum: Option<Vec<String>>,
    pub description: Option<String>,
}

An object representing a Server Variable for server URL template substitution.

See https://github.com/OAI/OpenAPI-Specification/blob/master/versions/3.0.1.md#serverVariableObject.

Fields

default: String

The default value to use for substitution, and to send, if an alternate value is not supplied. Unlike the Schema Object's default, this value MUST be provided by the consumer.

substitutions_enum: Option<Vec<String>>

An enumeration of string values to be used if the substitution options are from a limited set.

description: Option<String>

An optional description for the server variable. CommonMark syntax MAY be used for rich text representation.

Trait Implementations

impl Clone for ServerVariable

fn clone(&self) -> ServerVariable

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for ServerVariable

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

Formats the value using the given formatter.

impl Default for ServerVariable

fn default() -> ServerVariable

Returns the "default value" for a type.

impl<'de> Deserialize<'de> for ServerVariable

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

Deserialize this value from the given Serde deserializer.

impl PartialEq<ServerVariable> for ServerVariable

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

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

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

This method tests for !=.

impl Serialize for ServerVariable

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 ServerVariable