api

Documentation

Index

• func GetNamespace(req *rest.Request) string
• type Health
  • func NewHealth(reporter metrics.Reporter) *Health
  • func (h *Health) GetHealth(w rest.ResponseWriter, req *rest.Request) error
  • func (h *Health) Routes(middlewares ...rest.Middleware) []*rest.Route
• type Rule
  • func NewRule(m rules.Manager, r metrics.Reporter) *Rule
  • func (r *Rule) Routes(middlewares ...rest.Middleware) []*rest.Route
• type RuleList

Functions

func GetNamespace

func GetNamespace(req *rest.Request) string

GetNamespace from a request

Types

type Health

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

Health handles health API calls

func NewHealth

func NewHealth(reporter metrics.Reporter) *Health

NewHealth creates struct

func (*Health) GetHealth

func (h *Health) GetHealth(w rest.ResponseWriter, req *rest.Request) error

GetHealth performs health check on controller and dependencies

func (*Health) Routes

func (h *Health) Routes(middlewares ...rest.Middleware) []*rest.Route

Routes for health check API

type Rule

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

Rule API.

func NewRule

func NewRule(m rules.Manager, r metrics.Reporter) *Rule

NewRule constructs a new Rule API.

func (*Rule) Routes

func (r *Rule) Routes(middlewares ...rest.Middleware) []*rest.Route

Routes returns this API's routes wrapped by the middlewares.

type RuleList

type RuleList struct {
	Rules    []rules.Rule `json:"rules"`
	Revision int64        `json:"revision"`
}

RuleList is used to output the results of rule queries.