Struct Info

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

Provides metadata about the API.

The metadata may be used by clients if needed, and may be presented in editing or documentation generation tools for convenience.

Fields

title: String

The title of the application.

description: Option<String>

A verbose description of the application.

GitHub Flavored Markdown syntax may be used for rich text representation.

terms_of_service: Option<String>

A URL to the Terms of Service for the API.

This must contain an URL.

contact: Option<Contact>

contact information for the exposed API.

license: Option<License>

License information for the exposed API.

version: String

The version of the OpenRPC document.

Note that this is distinct from the openrpc field of OpenRpc which specifies the version of the OpenRPC Specification used.

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<'de> Deserialize<'de> for Info

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

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.