Struct openapiv3::Link

pub struct Link {
    pub description: Option<String>,
    pub operation_ref: Option<String>,
    pub operation_id: Option<String>,
    pub request_body: Option<String>,
    pub parameters: IndexMap<String, String>,
    pub server: Option<Server>,
    pub extensions: IndexMap<String, Value>,
}

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.

Fields

description: Option<String>

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

operation_ref: Option<String>

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.

operation_id: Option<String>

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

request_body: Option<String>

A literal value or {expression} to use as a request body when calling the target operation.

parameters: IndexMap<String, String>

A map representing parameters to pass to an operation as specified with operationId or identified via operationRef. The key is the parameter name to be used, whereas the value can be a constant or an expression to be evaluated and passed to the linked operation. The parameter name can be qualified using the parameter location [{in}.]{name} for operations that use the same parameter name in different locations (e.g. path.id).

server: Option<Server>

A server object to be used by the target operation.

extensions: IndexMap<String, Value>

Inline extensions to this object.

Trait Implementations

impl Clone for Link

fn clone(&self) -> Link

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Link

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

Formats the value using the given formatter.

impl Default for Link

fn default() -> Link

Returns the “default value” for a type.

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.

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 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 StructuralPartialEq for Link