health

Documentation

Index

• func Configure(api *operations.ClaAPI, service Service)
• type RepositoryService
  • func NewRepository(db *sqlx.DB) RepositoryService
• type Service
  • func New(repo RepositoryService, version, commit, branch, buildDate string) Service
  • func (s Service) HealthCheck(ctx context.Context, in health.GetHealthParams) (*models.Health, error)

Functions

func Configure

func Configure(api *operations.ClaAPI, service Service)

Configure setups handlers on api with service

Types

type RepositoryService

type RepositoryService interface {
	IsAlive() bool
}

RepositoryService is the health repository service interface definition

func NewRepository

func NewRepository(db *sqlx.DB) RepositoryService

NewRepository creates a new health repository service instance

type Service

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

Service provides an API to the health API

func New

func New(repo RepositoryService, version, commit, branch, buildDate string) Service

New is a simple helper function to create a health service instance

func (Service) HealthCheck

func (s Service) HealthCheck(ctx context.Context, in health.GetHealthParams) (*models.Health, error)

HealthCheck API call returns the current health of the service