Struct Link

pub struct Link {
    pub operation_identifier: Option<OperationIdentifier>,
    pub parameters: BTreeMap<String, AnyOrExpression>,
    pub request_body: Option<AnyOrExpression>,
    pub description: Option<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

operation_identifier: Option<OperationIdentifier>

parameters: BTreeMap<String, AnyOrExpression>

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).

request_body: Option<AnyOrExpression>

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

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.

extensions: IndexMap<String, Value>

This object MAY be extended with Specification Extensions.

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 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 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.