health

Documentation

Index

• type HealthController
  • func NewHealthController(queue worker.Queue[types.Mail]) *HealthController
  • func (c *HealthController) GetHealth(r *http.Request) api.Response
  • func (c *HealthController) Route(r api.Router)

Types

type HealthController

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

func NewHealthController

func NewHealthController(queue worker.Queue[types.Mail]) *HealthController

func (*HealthController) GetHealth

func (c *HealthController) GetHealth(r *http.Request) api.Response

GetHealth godoc

@Summary		Check service health
@Description	Returns the health status of the service including queue and SMTP connectivity
@Tags			Health
@Produce		json
@Success		200	{object}	map[string]interface{}	"Service is healthy"
@Failure		500	{object}	map[string]interface{}	"Service is unhealthy"
@Router			/api/v1/health [get]

func (*HealthController) Route

func (c *HealthController) Route(r api.Router)