fix: add /healthz to root link list (#804)

This adds `/healthz` the the root link list

Author: morremeyer

api/docs.go

@@ -5153,6 +5153,11 @@ const docTemplate = `{
                     "type": "string",
                     "example": "https://example.com/api/docs/index.html"
                 },
+                "healthz": {
+                    "description": "Healthz endpoint",
+                    "type": "string",
+                    "example": "https://example.com/api/healtzh"
+                },
                 "v1": {
                     "description": "List endpoint for all v1 endpoints",
                     "type": "string",

api/swagger.json

@@ -5142,6 +5142,11 @@
                     "type": "string",
                     "example": "https://example.com/api/docs/index.html"
                 },
+                "healthz": {
+                    "description": "Healthz endpoint",
+                    "type": "string",
+                    "example": "https://example.com/api/healtzh"
+                },
                 "v1": {
                     "description": "List endpoint for all v1 endpoints",
                     "type": "string",

api/swagger.yaml

@@ -1138,6 +1138,10 @@ definitions:
         description: Swagger API documentation
         example: https://example.com/api/docs/index.html
         type: string
+      healthz:
+        description: Healthz endpoint
+        example: https://example.com/api/healtzh
+        type: string
       v1:
         description: List endpoint for all v1 endpoints
         example: https://example.com/api/v1

pkg/router/router.go

@@ -146,6 +146,7 @@ type RootResponse struct {
 
 type RootLinks 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
 	V1      string `json:"v1" example:"https://example.com/api/v1"`                // List endpoint for all v1 endpoints
 	V2      string `json:"v2" example:"https://example.com/api/v2"`                // List endpoint for all v2 endpoints
@@ -162,6 +163,7 @@ func GetRoot(c *gin.Context) {
 	c.JSON(http.StatusOK, RootResponse{
 		Links: RootLinks{
 			Docs:    c.GetString(string(database.ContextURL)) + "/docs/index.html",
+			Healthz: c.GetString(string(database.ContextURL)) + "/healthz",
 			Version: c.GetString(string(database.ContextURL)) + "/version",
 			V1:      c.GetString(string(database.ContextURL)) + "/v1",
 			V2:      c.GetString(string(database.ContextURL)) + "/v2",

pkg/router/router_test.go

@@ -88,6 +88,7 @@ func TestGetRoot(t *testing.T) {
 	l := router.RootResponse{
 		Links: router.RootLinks{
 			Docs:    "/docs/index.html",
+			Healthz: "/healthz",
 			Version: "/version",
 			V1:      "/v1",
 			V2:      "/v2",