api

Documentation

Index

• Variables
• type Api
  • func NewApi() *Api
  • func (a *Api) Start(onShutdown ...func())
• type AuthController
  • func NewAuthController(svc *service.Provider) *AuthController
  • func (c AuthController) Setup(r chi.Router)
• type Controller
• type EveController
  • func NewEveController(svc *service.Provider) *EveController
  • func (c EveController) Setup(r chi.Router)
• type PingController
  • func NewPingController() *PingController
  • func (c PingController) Setup(r chi.Router)
• type SlackController
  • func NewSlackController(svc *service.Provider, exe interfaces.CommandExecutor) *SlackController
  • func (c SlackController) Setup(r chi.Router)
• type TokenResponse

Variables

var (
	Branch     = version.Branch
	SHA        = version.SHA
	ShortSHA   = version.ShortSHA
	Author     = version.Author
	BuildHost  = version.BuildHost
	Version    = version.Version
	Date       = version.Date
	Prerelease = version.Prerelease
)

Types

type Api

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

func NewApi

func NewApi() *Api

func (*Api) Start

func (a *Api) Start(onShutdown ...func())

Start starts the Mux Service Listeners (API/Metrics)

type AuthController

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

AuthController is the Controller/Handler for ping routes

func NewAuthController

func NewAuthController(svc *service.Provider) *AuthController

NewAuthController creates a new OIDC controller

func (AuthController) Setup

func (c AuthController) Setup(r chi.Router)

Setup satisfies the EveController interface for setting up the

type Controller

type Controller interface {
	Setup(chi.Router)
}

type EveController

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

EveController for eve specific routes

func NewEveController

func NewEveController(svc *service.Provider) *EveController

NewEveController New creates a new eve controller (route handler)

func (EveController) Setup

func (c EveController) Setup(r chi.Router)

Setup the routes

type PingController

type PingController struct {
}

PingController is the Controller/Handler for ping routes

func NewPingController

func NewPingController() *PingController

NewPingController creates a new ping controller

func (PingController) Setup

func (c PingController) Setup(r chi.Router)

Setup satisfies the EveController interface for setting up the

type SlackController

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

SlackController for slack routes

func NewSlackController

func NewSlackController(svc *service.Provider, exe interfaces.CommandExecutor) *SlackController

NewSlackController creates a new slack controller (route handler)

func (SlackController) Setup

func (c SlackController) Setup(r chi.Router)

Setup the routes

type TokenResponse

type TokenResponse struct {
	AccessToken string
	Expiry      time.Time
	Claims      *json.RawMessage
}