health

Documentation

Index

• Constants
• func SetupAPI(router gin.IRoutes, version string)
• type GetHealthResponse

Constants

const EndpointGetHealth = "/api/v1/health"

Functions

func SetupAPI

func SetupAPI(router gin.IRoutes, version string)

SetupAPI setups the REST API for configuration information

Types

type GetHealthResponse

type GetHealthResponse struct {
	Status  string `json:"status"`
	Version string `json:"version"`
}

GetHealthResponse contains the data that is send to the client requesting the health GET endpoint.