Enum jsona_openapi::Link
source · [−]pub enum Link {
Ref {
operation_ref: String,
parameters: Option<IndexMap<String, String>>,
description: Option<String>,
server: Option<Server>,
},
Id {
operation_id: String,
parameters: Option<IndexMap<String, String>>,
description: Option<String>,
server: Option<Server>,
},
}
Expand description
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
Fields
operation_ref: String
description: Option<String>
A description of the link. CommonMark syntax MAY be used for rich text representation.
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.
Id
Fields
operation_id: String
description: Option<String>
A description of the link. CommonMark syntax MAY be used for rich text representation.
The name of an existing, resolvable OAS operation, as defined with a unique
operationId
. This field is mutually exclusive of the operationRef
field.
Trait Implementations
sourceimpl<'de> Deserialize<'de> for Link
impl<'de> Deserialize<'de> for Link
sourcefn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>where
__D: Deserializer<'de>,
fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>where
__D: Deserializer<'de>,
Deserialize this value from the given Serde deserializer. Read more
sourceimpl PartialEq<Link> for Link
impl PartialEq<Link> for Link
impl StructuralPartialEq for Link
Auto Trait Implementations
impl RefUnwindSafe for Link
impl Send for Link
impl Sync for Link
impl Unpin for Link
impl UnwindSafe for Link
Blanket Implementations
sourceimpl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
const: unstable · sourcefn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read more