open_api_spex v3.18.0

View Source OpenApiSpex.Tag (open_api_spex v3.18.0)

Defines the OpenApiSpex.Tag.t type.

Link to this section Summary

Types

t()

Tag Object

Link to this section Types

Link to this type

t()

View Source 
@type t() :: %OpenApiSpex.Tag{
  description: String.t() | nil,
  extensions: %{required(String.t()) => any()} | nil,
  externalDocs: OpenApiSpex.ExternalDocumentation.t() | nil,
  name: String.t()
}

Tag Object

Adds metadata to a single tag that is used by the Operation Object. It is not mandatory to have a Tag Object per tag defined in the Operation Object instances.