version

Documentation

Index

• func Get(c *gin.Context)
• func Options(c *gin.Context)
• func RegisterRoutes(r *gin.RouterGroup, version string)
• type Object
• type Response

Functions

func Get

func Get(c *gin.Context)

@Summary API version @Description Returns the software version of the API @Tags General @Success 200 {object} Response @Router /version [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 /version [options]

func RegisterRoutes

func RegisterRoutes(r *gin.RouterGroup, version string)

Types

type Object

type Object struct {
	Version string `json:"version" example:"1.1.0"` // the running version of the Envelope Zero backend
}

type Response

type Response struct {
	Data Object `json:"data"` // Data object for the version endpoint
}