Enum openapi_rocketapi::v3_0::Link

pub enum Link {
    Ref {
        operation_ref: String,
        parameters: Option<BTreeMap<String, String>>,
        description: Option<String>,
        server: Option<Server>,
    },
    Id {
        operation_id: String,
        parameters: Option<BTreeMap<String, String>>,
        description: Option<String>,
        server: Option<Server>,
    },
}

The Link object represents a possible design-time link for a response.

The presence of a link does not guarantee the caller's ability to successfully invoke it, rather it provides a known relationship and traversal mechanism between responses and other operations.

Unlike dynamic links (i.e. links provided in the response payload), the OAS linking mechanism does not require link information in the runtime response.

For computing links, and providing instructions to execute them, a runtime expression is used for accessing values in an operation and using them as parameters while invoking the linked operation.

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

Variants

Ref

A relative or absolute reference to an OAS operation. This field is mutually exclusive of the operationId field, and MUST point to an Operation Object. Relative operationRef values MAY be used to locate an existing Operation Object in the OpenAPI definition.

Fields of Ref

operation_ref: Stringparameters: Option<BTreeMap<String, String>>description: Option<String>

A description of the link. CommonMark syntax MAY be used for rich text representation.

server: Option<Server>

A server object to be used by the target operation.

Id

The name of an existing, resolvable OAS operation, as defined with a unique operationId. This field is mutually exclusive of the operationRef field.

Fields of Id

operation_id: Stringparameters: Option<BTreeMap<String, String>>description: Option<String>

A description of the link. CommonMark syntax MAY be used for rich text representation.

server: Option<Server>

A server object to be used by the target operation.

Trait Implementations

impl Clone for Link

fn clone(&self) -> Link

Returns a copy of the value.

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

Performs copy-assignment from source.

impl PartialEq<Link> for Link

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

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

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

This method tests for !=.

impl Debug for Link

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

Formats the value using the given formatter.

impl Serialize for Link

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

Serialize this value into the given Serde serializer.

impl<'de> Deserialize<'de> for Link

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

Deserialize this value from the given Serde deserializer.