root

Documentation

Index

• func Get(c *gin.Context)
• func Options(c *gin.Context)
• func RegisterRoutes(r *gin.RouterGroup)
• type Links
• type Response

Functions

func Get

func Get(c *gin.Context)

@Summary API root @Description Entrypoint for the API, listing all endpoints @Tags General @Success 200 {object} Response @Router / [get]

func Options

func Options(c *gin.Context)

@Summary Allowed HTTP verbs @Description Returns an empty response with the HTTP Header "allow" set to the allowed HTTP verbs @Tags General @Success 204 @Router / [options]

func RegisterRoutes

func RegisterRoutes(r *gin.RouterGroup)

Types

type Links

type Links struct {
	Docs    string `json:"docs" example:"https://example.com/api/docs/index.html"` // Swagger API documentation
	Healthz string `json:"healthz" example:"https://example.com/api/healtzh"`      // Healthz endpoint
	Version string `json:"version" example:"https://example.com/api/version"`      // Endpoint returning the version of the backend
	Metrics string `json:"metrics" example:"https://example.com/api/metrics"`      // Endpoint returning Prometheus metrics
	V3      string `json:"v3" example:"https://example.com/api/v3"`                // List endpoint for all v3 endpoints
}

type Response

type Response struct {
	Links Links `json:"links"`
}