tag

Documentation

Index

• type Tag
  • func New(text string) Tag
  • func (t Tag) WithType(typ string) Tag

Types

type Tag

type Tag struct {
	Type string `json:"type"`
	Text string `json:"text"`
}

Tag is used in API documentation. It can be used to categorize APIs, or to mark an API as experimental or obsoleted.

func New

func New(text string) Tag

Create a Tag object.

func (Tag) WithType

func (t Tag) WithType(typ string) Tag

Sets the type of a Tag. The type defines its meaning. For example, a Tag used for API categorization might have a Type of "category", while a Tag that indicates the API status might use "status" as its Type.