routes

Documentation

Index

• type DMSRouter
  • func (r *DMSRouter) Ingest(c echo.Context) error
  • func (r *DMSRouter) Pingdom(c echo.Context) error
  • func (r *DMSRouter) Register(c echo.Context) error
  • func (r *DMSRouter) Status(c echo.Context) error

Types

type DMSRouter

type DMSRouter struct {
	Store               storage.StorageImpl
	JWTSecret           string
	HeartbeatExpiration time.Duration
}

DMSRouter contains all the routes for the DMS functionality

func (*DMSRouter) Ingest

func (r *DMSRouter) Ingest(c echo.Context) error

Ingest is the primary heartbeat route

func (*DMSRouter) Pingdom

func (r *DMSRouter) Pingdom(c echo.Context) error

Pingdom is the endpoint that pingdom will query, it returns 200 if all the checks are within the heartbearExpiration and it returns 500 if any of the checks are outside of the heartbearExpiration

func (*DMSRouter) Register

func (r *DMSRouter) Register(c echo.Context) error

Register generates a JWT for use in authenticating against the /ingest route

func (*DMSRouter) Status

func (r *DMSRouter) Status(c echo.Context) error

Status is an internal endpoint