Struct LinkBuilder

pub struct LinkBuilder { /* private fields */ }

Builder for Link with chainable configuration methods to create a new Link.

Implementations

impl LinkBuilder

pub fn new() -> LinkBuilder

Constructs a new LinkBuilder.

pub fn build(self) -> Link

Constructs a new Link taking all fields values from this object.

impl LinkBuilder

pub fn operation_ref<S: Into<String>>(self, operation_ref: S) -> Self

Set a relative or absolute URI reference to an OAS operation. This field is mutually exclusive of the operation_id field, and must point to an Operation Object.

pub fn operation_id<S: Into<String>>(self, operation_id: S) -> Self

Set the name of an existing, resolvable OAS operation, as defined with a unique operation_id. This field is mutually exclusive of the operation_ref field.

pub fn parameter<N: Into<String>, V: Into<Value>>( self, name: N, value: V, ) -> Self

Add parameter to be passed to Operation upon execution.

pub fn request_body<B: Into<Value>>(self, request_body: Option<B>) -> Self

Set a literal value or an expression to be used as request body when operation is called.

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

Set description of the link. Value supports Markdown syntax.

pub fn server<S: Into<Server>>(self, server: Option<S>) -> Self

Set a Server object to be used by the target operation.

pub fn extensions(self, extensions: Option<Extensions>) -> Self

Add openapi extensions (x-something) of the API.

Trait Implementations

impl Default for LinkBuilder

fn default() -> Self

Returns the “default value” for a type.

impl From<Link> for LinkBuilder

fn from(value: Link) -> Self

Converts to this type from the input type.

impl From<LinkBuilder> for Link

fn from(value: LinkBuilder) -> Self

Converts to this type from the input type.