Struct Info

pub struct Info {
    pub title: String,
    pub version: String,
    pub summary: Option<String>,
    pub description: Option<String>,
    pub terms_of_service: Option<String>,
    pub contact: Option<Contact>,
    pub license: Option<License>,
    pub x_fields: HashMap<String, Value>,
}

Info Object

The object provides metadata about the API. The metadata can be used by the clients if needed, and can be presented in the Swagger-UI for convenience.

Fields

title: String

Required. The title of the application.

version: String

Required. Provides the version of the application API (not to be confused with the specification version).

summary: Option<String>

A short summary of the API. Available in v3.1 only

description: Option<String>

A short description of the application. GFM syntax can be used for rich text representation.

terms_of_service: Option<String>

The Terms of Service for the API.

contact: Option<Contact>

The contact information for the exposed API.

license: Option<License>

The license information for the exposed API.

x_fields: HashMap<String, Value>

Allows extensions to the Swagger Schema. The field name MUST begin with x-, for example, x-internal-id. The value can be null, a primitive, an array or an object. See Vendor Extensions for further details.

Trait Implementations

impl Clone for Info

fn clone(&self) -> Info

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Info

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

Formats the value using the given formatter.

impl Default for Info

fn default() -> Info

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for Info

where Info: Default,

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for Info

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

Tests for self and other values to be equal, and is used by ==.

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Serialize for Info

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 Info