web

Documentation

Index

• func GenerateKey(URL string) string
• func GetClusterDashName(shortName string) (string, error)
• func HTTPCache(client *cache.Cache[string], appConfig *config.AppConfig, tags []string) echo.MiddlewareFunc
• func Livez(c echo.Context) error
• func Metrics() echo.HandlerFunc
• func NewRouter() *echo.Echo
• func RateLimiter(appConfig *config.AppConfig) echo.MiddlewareFunc
• func Version(version string) echo.HandlerFunc
• type Response
  • func StringToResponse(s string) Response
  • func (r Response) String() string
• type StatusSessions
  • func (s *StatusSessions) Readyz(c echo.Context) error
• type Validator
  • func NewValidator() *Validator
  • func (v *Validator) Validate(i interface{}) error

Functions

func GenerateKey

func GenerateKey(URL string) string

func GetClusterDashName

func GetClusterDashName(shortName string) (string, error)

Convert cluster shortName into standard name format Ex. cluster01produseast1 becomes cluster01-prod-useast1

func HTTPCache

func HTTPCache(client *cache.Cache[string], appConfig *config.AppConfig, tags []string) echo.MiddlewareFunc

func Livez

func Livez(c echo.Context) error

Livez checks if the apiserver is up

func Metrics

func Metrics() echo.HandlerFunc

func NewRouter

func NewRouter() *echo.Echo

NewRouter func

func RateLimiter

func RateLimiter(appConfig *config.AppConfig) echo.MiddlewareFunc

RateLimiter returns a middleware.RateLimiterWithConfig

func Version

func Version(version string) echo.HandlerFunc

Version return an handler that returns the version of the app

Types

type Response

type Response struct {
	// Value is the cached response value.
	Value []byte

	// Header is the cached response header.
	Header http.Header
}

func StringToResponse

func StringToResponse(s string) Response

func (Response) String

func (r Response) String() string

type StatusSessions

type StatusSessions struct {
	SQS       *sqs.Config
	Db        database.Db
	AppConfig *config.AppConfig
	Metrics   monitoring.MetricsI
}

StatusSessions is used to keep the same objects and state for the database and sqs that are used for the rest of the calls inside the project

func (*StatusSessions) Readyz

func (s *StatusSessions) Readyz(c echo.Context) error

Readyz checks if the services that the apiserver uses are healthy

type Validator

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

Validator func

func NewValidator

func NewValidator() *Validator

NewValidator func

func (*Validator) Validate

func (v *Validator) Validate(i interface{}) error

Validate func