Struct ExternalDocumentation

pub struct ExternalDocumentation {
    pub description: Option<String>,
    pub url: String,
    pub extensions: IndexMap<String, Value>,
}

Allows referencing an external resource for extended documentation.

Fields

description: Option<String>

A short description of the target documentation. CommonMark syntax MAY be used for rich text representation.

url: String

The URL for the target documentation. Value MUST be in the format of a URL.

extensions: IndexMap<String, Value>

This object MAY be extended with Specification Extensions.

Trait Implementations

impl Clone for ExternalDocumentation

fn clone(&self) -> ExternalDocumentation

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for ExternalDocumentation

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

Formats the value using the given formatter.

impl Default for ExternalDocumentation

fn default() -> ExternalDocumentation

Returns the “default value” for a type.

impl Serialize for ExternalDocumentation

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

where __S: Serializer,

Serialize this value into the given Serde serializer.