dictionary

Documentation

Index

• type Action
  • func (a *Action) Expr() []string
  • func (a *Action) Param(name string) *Parameter
• type Dictionary
  • func Retrieve(filepath string) (*Dictionary, error)
• type Handler
  • func (r *Handler) Action(name string) *Action
• type Option
• type Parameter
• type Type

Types

type Action

type Action struct {
	Name        string      `yaml:"name"`
	Handle      string      `yaml:"handle"`
	Description string      `yaml:"description"`
	Expressions []string    `yaml:"expressions"`
	Parameters  []Parameter `yaml:"parameters"`
	Examples    []string    `yaml:"examples"`
}

func (*Action) Expr

func (a *Action) Expr() []string

func (*Action) Param

func (a *Action) Param(name string) *Parameter

type Dictionary

type Dictionary struct {
	Handlers []Handler `yaml:"handlers"`
}

var (
	Base Dictionary
)

func Retrieve

func Retrieve(filepath string) (*Dictionary, error)

type Handler

type Handler struct {
	Name        string   `yaml:"name"`
	Resources   []string `yaml:"resources"`
	Description string   `yaml:"description"`
	Options     []Option `yaml:"options"`
	Actions     []Action `yaml:"actions"`
}

func (*Handler) Action

func (r *Handler) Action(name string) *Action

type Option

type Option struct {
	Name        string `yaml:"name"`
	Description string `yaml:"description"`
	Type        string `yaml:"type"`
}

type Parameter

type Parameter struct {
	Name        string `yaml:"name"`
	Description string `yaml:"description"`
	Type        string `yaml:"type"`
}

type Type

type Type struct {
	Expression string `yaml:"expression"`
}