routes

Documentation

Index

• Constants
• func CalculateHTTPStatusCode(err error) int
• func SetUpHealthCheck(server *gin.Engine)
• func SetUpIndexPage(server *gin.Engine)
• func SetUpPrometheus(server *gin.Engine)
• func SetUpSwagger(server *gin.Engine)
• func URLParamsToFilter(c *gin.Context, filter interface{}, fields map[string]int) (size int, page int, err error)
• type HTTPResult

Constants

const (
	MaxSize          = 500
	FirstPage        = 0
	SizeURLParamName = "size"
	PageURLParamName = "page"
)

const (
	HealthCheckURL = "/health"
)

Functions

func CalculateHTTPStatusCode

func CalculateHTTPStatusCode(err error) int

We should develop a custom exception on the repository layer. But we rely on kubernetes exceptions for now. TODO: implement Legion exceptions

func SetUpHealthCheck

func SetUpHealthCheck(server *gin.Engine)

func SetUpIndexPage

func SetUpIndexPage(server *gin.Engine)

func SetUpPrometheus

func SetUpPrometheus(server *gin.Engine)

func SetUpSwagger

func SetUpSwagger(server *gin.Engine)

func URLParamsToFilter

func URLParamsToFilter(c *gin.Context, filter interface{}, fields map[string]int) (size int, page int, err error)

Types

type HTTPResult

type HTTPResult struct {
	// Success of error message
	Message string `json:"message"`
}