taggroups

Documentation

Index

• Constants
• func SpecTagsWithoutGroups(spec *openapi3.Spec, tagGroupSet TagGroupSet) []string
• type TagGroup
• type TagGroupSet
  • func NewTagGroupSet() TagGroupSet
  • func SpecTagGroups(spec *openapi3.Spec) (TagGroupSet, error)
  • func (set *TagGroupSet) AddToSpec(spec *openapi3.Spec) error
  • func (set *TagGroupSet) Exists(tagName string) bool
  • func (set *TagGroupSet) GetTagGroupNamesForTagNames(wantTagNames ...string) []string
  • func (set *TagGroupSet) OperationMoreTagGroupNames(opm *openapi3.OperationMore) string

Constants

const (
	XTagGroupsPropertyName      = "x-tagGroups" // Redocly format
	XTagGroupsPropertyNameKebab = "x-tag-groups"
)

Functions

func SpecTagsWithoutGroups

func SpecTagsWithoutGroups(spec *openapi3.Spec, tagGroupSet TagGroupSet) []string

Types

type TagGroup

type TagGroup struct {
	Name    string   `json:"name"`
	Popular bool     `json:"popular"`
	Tags    []string `json:"tags"`
}

type TagGroupSet

type TagGroupSet struct {
	TagGroups []TagGroup
}

func NewTagGroupSet

func NewTagGroupSet() TagGroupSet

func SpecTagGroups

func SpecTagGroups(spec *openapi3.Spec) (TagGroupSet, error)

SpecTagGroups parses a TagGroupSet from an OpenAPI3 spec.

func (*TagGroupSet) AddToSpec

func (set *TagGroupSet) AddToSpec(spec *openapi3.Spec) error

func (*TagGroupSet) Exists

func (set *TagGroupSet) Exists(tagName string) bool

func (*TagGroupSet) GetTagGroupNamesForTagNames

func (set *TagGroupSet) GetTagGroupNamesForTagNames(wantTagNames ...string) []string

func (*TagGroupSet) OperationMoreTagGroupNames

func (set *TagGroupSet) OperationMoreTagGroupNames(opm *openapi3.OperationMore) string

OperationMoreTagGroupNames this function is meant to be used with `SpecMore.Table()` and must follow the `OperationMoreStringFunc` interface.