config

type Command struct {
	Name    string `toml:"name"`
	Usage   string `toml:"usage"`
	Require string `toml:"require"`

	Prehook  string `toml:"prehook"`
	Handler  string `toml:"handler"`
	Posthook string `toml:"posthook"`
}

type Config struct {
	Name string `toml:"name"`

	Dir     string `toml:"dir"`
	Port    uint16 `toml:"port"`
	TLSPort uint16 `toml:"tlsPort"`
	TLSDir  string `toml:"tlsDir"`

	ErrorLogger func(error)

	IncludeConfig

	PerformUpdate bool `toml:"-"`

	Flags map[string]string `toml:"-"`

	// Plugin keys as they are referenced by the plugins store
	PluginKeys []string

	ExampleRequests  map[string]*Request
	ExampleResponses map[string]*Response
}

type Flag struct {
	Name         string `toml:"name"`
	DefaultValue string `toml:"defaultValue"`
	Usage        string `toml:"usage"`
}

type Group struct {
	Name string `toml:"name"`
	// Route group
	Group string `toml:"group"`
	// HTTP method
	Method string `toml:"method"`
	// HTTP path
	HTTPPath string `toml:"httpPath"`
	// Plugin handlers
	Handlers []string `toml:"handlers"`

	HTTPHandlers []common.Handler `toml:"-"`

	G common.Group `toml:"-"`

	// Requests are keys to the request map which includes example request/response data for docs and tests
	Requests map[string]*Request
}

type IncludeConfig struct {
	// Application environment
	Environment map[string]string `toml:"env"`

	// Allow included files to add includes
	Include []string `toml:"include"`

	// Specify which plugins are in scope
	Plugins []string `toml:"plugins"`

	// Commands are the dynamic commands specified in config
	CommandEntries []*Command `toml:"command"`
	// Flags are the dynamic flags specified in config
	FlagEntries []*Flag `toml:"flag"`

	// Groups are the route groups
	Groups []*Group `toml:"group"`
	// Routes are the routes to listen for and serve
	Routes []*Route `toml:"route"`

	// Requests are example requests for docs/tests
	Requests []*Request `toml:"request"`
	// Responses are example responses for docs/tests
	Responses []*Response `toml:"response"`
}

type PluginConfig struct {
	// Specify which plugins are in scope
	Plugins []string `toml:"plugins"`
}

type Request struct {
	// ID
	Name  string `toml:"name"`
	Group string `toml:"group"`

	Query map[string]string `toml:"query"`
	Body  map[string]string `toml:"body"`

	Responses        []string    `toml:"responses"`
	ResponseExamples []*Response `toml:"-"`

	// Links
	Parent string `toml:"parent"`
	// contains filtered or unexported fields
}

type Response struct {
	// ID
	Name string `toml:"name"`

	// Links
	Parent string `toml:"parent"`

	// Inheritable vals
	Code int               `toml:"code"`
	Data map[string]string `toml:"data"`
	// contains filtered or unexported fields
}

type Route struct {
	// Target plug-in handler
	HTTPHandlers []common.Handler `toml:"-"`

	// Route name/description
	Name string `toml:"name"`
	// Route group
	Group string `toml:"group"`
	// HTTP method
	Method string `toml:"method"`
	// HTTP path
	HTTPPath string `toml:"httpPath"`
	// Directory or file to serve
	Target string `toml:"target"`
	// Plugin handlers
	Handlers []string `toml:"handlers"`

	RequestExample *Request
}