Struct Tag 

#[non_exhaustive]
pub struct Tag {
    pub name: String,
    pub summary: Option<String>,
    pub description: Option<String>,
    pub external_docs: Option<ExternalDocs>,
    pub parent: Option<String>,
    pub kind: Option<String>,
    pub extensions: PropMap<String, Value>,
}

Implements OpenAPI Tag Object.

Tag can be used to provide additional metadata for tags used by path operations.

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

name: String

Name of the tag. Should match to tag of operation.

summary: Option<String>

Short summary of the tag, used for display purposes. Added in OpenAPI 3.2 as the standardized replacement for the x-displayName extension.

See https://spec.openapis.org/oas/v3.2.0.html#tag-object.

description: Option<String>

Additional description for the tag shown in the document.

external_docs: Option<ExternalDocs>

Additional external documentation for the tag.

parent: Option<String>

Tag::name of the tag this tag is nested under. Added in OpenAPI 3.2.

The named tag must exist in the document and circular parent/child references are not allowed; neither condition is validated here.

kind: Option<String>

Machine-readable string categorizing what sort of tag this is. Added in OpenAPI 3.2.

Any string is allowed; commonly used values are nav, badge and audience. See the registry for the well-known values.

extensions: PropMap<String, Value>

Optional extensions “x-something”

Implementations

impl Tag

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

Construct a new Tag with given name.

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

Add name of the tag.

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

Add a short summary used for display purposes. Requires OpenAPI 3.2.

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

Add additional description for the tag.

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

Nest this tag under the tag with the given name. Requires OpenAPI 3.2.

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

Categorize the tag, e.g. nav, badge or audience. Requires OpenAPI 3.2.

pub fn external_docs(self, external_docs: ExternalDocs) -> Self

Add additional external documentation for the tag.

pub fn add_extension<K: Into<String>>(self, key: K, value: Value) -> Self

Add openapi extension (x-something) for Tag.

Trait Implementations

impl Clone for Tag

fn clone(&self) -> Tag

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for Tag

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

Formats the value using the given formatter.

impl Default for Tag

fn default() -> Tag

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for Tag

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Eq for Tag

impl<'a> From<&'a str> for Tag

fn from(name: &'a str) -> Self

Converts to this type from the input type.

impl From<&String> for Tag

fn from(name: &String) -> Self

Converts to this type from the input type.

impl From<String> for Tag

fn from(name: String) -> Self

Converts to this type from the input type.

impl Ord for Tag

fn cmp(&self, other: &Self) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized,

Restrict a value to a certain interval.

impl PartialEq for Tag

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

Equality operator ==.

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

Inequality operator !=.

impl PartialOrd for Tag

fn partial_cmp(&self, other: &Self) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

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

Tests less than (for self and other) and is used by the < operator.

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

Tests less than or equal to (for self and other) and is used by the <= operator.

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

Tests greater than (for self and other) and is used by the > operator.

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

Tests greater than or equal to (for self and other) and is used by the >= operator.

impl Serialize for Tag

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 Tag