Struct Tag 

pub struct Tag {
    pub name: String,
    pub summary: Option<String>,
    pub description: Option<String>,
    pub parent: Option<String>,
    pub kind: Option<String>,
    pub external_docs: Option<ExternalDocumentation>,
    pub extensions: Extensions,
}

Metadata for a single tag used by Operation::tags.

Tag names must be unique across a document. In Kynos a tag is a type rather than a string, so uniqueness is a property of the type system rather than something checked after the fact.

Fields

name: String

The name of the tag. Operations refer to it by this value.

summary: Option<String>

A short summary of the tag.

Introduced in OpenAPI 3.2.

description: Option<String>

A description for the tag. CommonMark syntax may be used.

parent: Option<String>

The name of a tag that this tag nests under.

Introduced in OpenAPI 3.2. The named tag must exist, and the parent chain must not contain a cycle; crate::validate checks both.

kind: Option<String>

A machine-readable categorization of what sort of tag this is.

Introduced in OpenAPI 3.2. Any string is permitted; nav, badge and audience are the common registered values.

external_docs: Option<ExternalDocumentation>

Additional external documentation for this tag.

extensions: Extensions

Specification extensions.

Implementations

impl Tag

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

Creates a tag with the given name.

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

Sets the description.

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

Nests this tag under another.

Introduced in OpenAPI 3.2.

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

Sets the machine-readable tag category.

Introduced in OpenAPI 3.2.

Trait Implementations

impl Clone for Tag

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 Tag

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

Formats the value using the given formatter.

impl Default for Tag

fn default() -> Self

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 PartialEq for Tag

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

Equality operator ==.

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

Inequality 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