api

Documentation

Index

• Constants
• func AddRoutes(routerGroup *gin.RouterGroup) *gin.RouterGroup
• func HealthCheck(c *gin.Context)
• type ErrorResponse

Constants

const HealthCheckPath = "/health/full"

Functions

func AddRoutes

func AddRoutes(routerGroup *gin.RouterGroup) *gin.RouterGroup

func HealthCheck

func HealthCheck(c *gin.Context)

HealthCheck godoc

@Summary		Health Status of Naavik
@Description	Health Status of Naavik
@Tags			Health Check
@Produce		json
@Success		200	string	Health	full	ok
@Router			/health/full [get].

Types

type ErrorResponse

type ErrorResponse struct {
	Message string `json:"error"`
}