api

Documentation

Index

• func Health(c echo.Context) error
• func Shutdown() error
• func Start(ctx context.Context) error
• type HealthResponse
• type Status

Functions

func Health

func Health(c echo.Context) error

Health is used to determine if Caesium is healthy. The response also includes the uptime.

func Shutdown

func Shutdown() error

func Start

func Start(ctx context.Context) error

Start launches Caesium's API.

Types

type HealthResponse

type HealthResponse struct {
	Status Status        `json:"status"`
	Uptime time.Duration `json:"uptime"`
}

HealthResponse defines the data the Health REST endpoint returns.

type Status

type Status string

Status enumerates the health statues of Caesium.

const (
	// Healthy implies Caesium is having no major issues.
	Healthy Status = "healthy"
)