annotations

Documentation

Index

• Constants
• func GetCastProperty[TPropertyType any](attrib *Attribute, property string) (*TPropertyType, error)
• type AnnotationHolder
  • func NewAnnotationHolder(comments []string) (AnnotationHolder, error)
  • func (holder AnnotationHolder) FindFirstByProperty(key string, value string) *Attribute
  • func (holder AnnotationHolder) FindFirstByValue(value string) *Attribute
  • func (holder AnnotationHolder) GetAll(attribute string) []*Attribute
  • func (holder AnnotationHolder) GetDescription() string
  • func (holder AnnotationHolder) GetFirst(attribute string) *Attribute
  • func (holder AnnotationHolder) GetFirstDescriptionOrEmpty(attribute string) string
  • func (holder AnnotationHolder) GetFirstValueOrEmpty(attribute string) string
  • func (holder AnnotationHolder) Has(attribute string) bool
• type Attribute
  • func (attr Attribute) GetProperty(name string) *any
  • func (attr Attribute) HasProperty(name string) bool
• type NonAttributeComment

Constants

const (
	PropertyName            = "name"
	PropertySecurityScopes  = "scopes"
	PropertyValidatorString = "validate"
)

const (
	AttributeTag              = "Tag"
	AttributeQuery            = "Query"
	AttributePath             = "Path"
	AttributeBody             = "Body"
	AttributeHeader           = "Header"
	AttributeDeprecated       = "Deprecated"
	AttributeHidden           = "Hidden"
	AttributeSecurity         = "Security"
	AttributeAdvancedSecurity = "AdvancedSecurity"
	AttributeRoute            = "Route"
	AttributeResponse         = "Response"
	AttributeDescription      = "Description"
	AttributeMethod           = "Method"
	AttributeErrorResponse    = "ErrorResponse"
)

Functions

func GetCastProperty

func GetCastProperty[TPropertyType any](attrib *Attribute, property string) (*TPropertyType, error)

Types

type AnnotationHolder

type AnnotationHolder struct {
	// contains filtered or unexported fields
}

func NewAnnotationHolder

func NewAnnotationHolder(comments []string) (AnnotationHolder, error)

func (AnnotationHolder) FindFirstByProperty

func (holder AnnotationHolder) FindFirstByProperty(key string, value string) *Attribute

func (AnnotationHolder) FindFirstByValue

func (holder AnnotationHolder) FindFirstByValue(value string) *Attribute

func (AnnotationHolder) GetAll

func (holder AnnotationHolder) GetAll(attribute string) []*Attribute

func (AnnotationHolder) GetDescription

func (holder AnnotationHolder) GetDescription() string

func (AnnotationHolder) GetFirst

func (holder AnnotationHolder) GetFirst(attribute string) *Attribute

func (AnnotationHolder) GetFirstDescriptionOrEmpty

func (holder AnnotationHolder) GetFirstDescriptionOrEmpty(attribute string) string

func (AnnotationHolder) GetFirstValueOrEmpty

func (holder AnnotationHolder) GetFirstValueOrEmpty(attribute string) string

func (AnnotationHolder) Has

func (holder AnnotationHolder) Has(attribute string) bool

type Attribute

type Attribute struct {
	Name        string
	Value       string
	Properties  map[string]any
	Description string
}

func (Attribute) GetProperty

func (attr Attribute) GetProperty(name string) *any

func (Attribute) HasProperty

func (attr Attribute) HasProperty(name string) bool

type NonAttributeComment

type NonAttributeComment struct {
	Index int
	Value string
}