genericapi

Documentation

Index

• type Config
• type Handler
  • func NewHandler(c Config) *Handler
  • func (h *Handler) ServeCreateAlert(w http.ResponseWriter, r *http.Request)
  • func (h *Handler) ServeHeartbeatCheck(w http.ResponseWriter, r *http.Request)
  • func (h *Handler) ServeUserAvatar(w http.ResponseWriter, req *http.Request)

Types

type Config

type Config struct {
	AlertStore          *alert.Store
	IntegrationKeyStore *integrationkey.Store
	HeartbeatStore      *heartbeat.Store
	UserStore           *user.Store
}

Config contains the values needed to implement the generic API handler.

type Handler

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

Handler responds to generic API requests

func NewHandler

func NewHandler(c Config) *Handler

NewHandler creates a new Handler, registering generic API routes using chi.

func (*Handler) ServeCreateAlert

func (h *Handler) ServeCreateAlert(w http.ResponseWriter, r *http.Request)

ServeCreateAlert allows creating or closing an alert.

func (*Handler) ServeHeartbeatCheck

func (h *Handler) ServeHeartbeatCheck(w http.ResponseWriter, r *http.Request)

ServeHeartbeatCheck serves the heartbeat check-in endpoint.

func (*Handler) ServeUserAvatar

func (h *Handler) ServeUserAvatar(w http.ResponseWriter, req *http.Request)

ServeUserAvatar will serve a redirect for a users avatar image.