Struct Ref 

pub struct Ref {
    pub location: String,
    pub summary: Option<String>,
    pub description: Option<String>,
}

A reference to another part of this or another description.

This is not a JSON Schema $ref

The specification draws a sharp line that is easy to miss. A Reference Object — this type — has exactly three fields, and any other property present alongside them shall be ignored. A Schema Object $ref is plain JSON Schema 2020-12, where sibling keywords are fully applied.

Schema therefore models $ref as an ordinary keyword, and does not use this type.

Accordingly this object carries no Extensions: it cannot be extended.

Fields

location: String

The URI of the referenced component.

summary: Option<String>

A short summary, overriding that of the referenced component.

description: Option<String>

A description, overriding that of the referenced component.

CommonMark syntax may be used.

Implementations

impl Ref

pub fn new(location: impl Into<String>) -> Self

References an arbitrary URI.

pub fn schema(name: &str) -> Self

References a named entry under #/components/schemas.

pub fn response(name: &str) -> Self

References a named entry under #/components/responses.

pub fn parameter(name: &str) -> Self

References a named entry under #/components/parameters.

pub fn request_body(name: &str) -> Self

References a named entry under #/components/requestBodies.

pub fn security_scheme(name: &str) -> Self

References a named entry under #/components/securitySchemes.

pub fn with_summary(self, summary: impl Into<String>) -> Self

Sets the overriding summary.

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

Sets the overriding description.

Trait Implementations

impl Clone for Ref

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 Ref

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for Ref

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Eq for Ref

impl<T> From<Ref> for RefOr<T>

fn from(reference: Ref) -> Self

Converts to this type from the input type.

impl PartialEq for Ref

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

Equality operator ==.

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

Inequality operator !=.

impl Serialize for Ref

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 Ref