Struct RefBuilder 

pub struct RefBuilder { /* private fields */ }

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

Implementations

impl RefBuilder

pub fn new() -> RefBuilder

Constructs a new RefBuilder.

pub fn build(self) -> Ref

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

impl RefBuilder

pub fn ref_location(self, ref_location: String) -> Self

Add or change reference location of the actual component.

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

Add or change reference location of the actual component automatically formatting the $ref to #/components/schemas/... format.

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

Add or change description which by default should override that of the referenced component. Description supports markdown syntax. If referenced object type does not support description this field does not have effect.

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

Add or change short summary which by default should override that of the referenced component. If referenced component does not support summary field this does not have effect.

Trait Implementations

impl Default for RefBuilder

fn default() -> Self

Returns the “default value” for a type.

impl From<Ref> for RefBuilder

fn from(value: Ref) -> Self

Converts to this type from the input type.

impl From<RefBuilder> for AdditionalProperties<Schema>

fn from(value: RefBuilder) -> Self

Converts to this type from the input type.

impl From<RefBuilder> for ArrayItems

fn from(value: RefBuilder) -> Self

Converts to this type from the input type.

impl From<RefBuilder> for Ref

fn from(value: RefBuilder) -> Self

Converts to this type from the input type.

impl From<RefBuilder> for RefOr<Schema>

fn from(builder: RefBuilder) -> Self

Converts to this type from the input type.