health

Documentation

Index

• func Configure(api *operations.ClaAPI, service Service)
• type HealthService
• type Service
  • func New(version, commit, branch, buildDate string) Service
  • func (s Service) HealthCheck(ctx context.Context) (*models.Health, error)

Functions

func Configure

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

Configure setups handlers on api with service

Types

type HealthService

type HealthService interface {
	HealthCheck(ctx context.Context) (*models.Health, error)
}

HealthService interface

type Service

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

Service provides an API to the health API

func New

func New(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) (*models.Health, error)

HealthCheck API call returns the current health of the service