Struct Link 

pub struct Link {
    pub parameters: Map<Value>,
    pub request_body: Option<Value>,
    pub description: Option<String>,
    pub server: Option<Server>,
    pub extensions: Extensions,
    /* private fields */
}

A design-time link from one response to another operation.

A link says “the value at this location in my response is the id parameter of that operation”. It is the one construct in OpenAPI that expresses the relationship between operations, and no mainstream Rust framework emits it.

The target is a LinkTarget, which is operationRef or operationId and never both or neither.

Fields

parameters: Map<Value>

Parameters to pass to the target operation.

Each value is either a constant or a runtime expression such as $response.body#/id.

request_body: Option<Value>

A request body to pass to the target operation.

description: Option<String>

A description of the link. CommonMark syntax may be used.

server: Option<Server>

A server to use for the target operation.

extensions: Extensions

Specification extensions.

Implementations

impl Link

pub fn to_operation(operation_id: impl Into<String>) -> Self

Links to an operation by its operationId.

pub fn to_operation_ref(operation_ref: impl Into<String>) -> Self

Links to an operation by URI reference.

pub fn target(&self) -> &LinkTarget

The operation this link points at.

pub fn operation_ref(&self) -> Option<&str>

The URI reference to the target, when the link points at one that way.

pub fn operation_id(&self) -> Option<&str>

The operationId of the target, when the link names one.

pub fn with_parameter( self, name: impl Into<String>, value: impl Into<Value>, ) -> Self

Binds a target parameter to a constant or runtime expression.

pub fn with_description(self, description: impl Into<String>) -> Self

Sets the description.

Trait Implementations

impl Clone for Link

fn clone(&self) -> Self

Returns a duplicate 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<'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 Eq for Link

impl PartialEq for Link

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

Equality operator ==.

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

Inequality operator !=.

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