healthcontroller

package
v0.14.0 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Mar 31, 2026 License: AGPL-3.0 Imports: 8 Imported by: 0

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

func RegisterSwaggerDocsRoute

func RegisterSwaggerDocsRoute(docsRouter gin.IRouter, kc config.KeycloakConfig)

Types

type HealthController

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

func NewHealthController

func NewHealthController(router gin.IRouter, healthService healthservice.HealthService) *HealthController

func (*HealthController) Alive

func (c *HealthController) Alive(gc *gin.Context)

@Summary Service health status Alive @Description Endpoint for 'alive' health probes @Tags health @Success 200 "Alive" @Router /health/alive [get]

func (*HealthController) Ready

func (c *HealthController) Ready(gc *gin.Context)

@Summary Service health status Ready @Description Indicates if the service is ready to serve traffic @Tags health @Success 200 "Ready" @Failure 404 "Not ready" @Router /health/ready [get]

func (*HealthController) Started

func (c *HealthController) Started(gc *gin.Context)

@Summary Service health status Started @Description Endpoint for 'started' health probes @Tags health @Success 200 "Started" @Router /health/started [get]

Directories

Path Synopsis

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL