Merge pull request #262 from checkr/zz/fix-health-check-endpoint

Fix health check endpoint
openflagr · May 24, 2019 · 1293e27 · 1293e27
2 parents e701af9 + 484680f
commit 1293e27
Show file tree

Hide file tree

Showing 11 changed files with 120 additions and 15 deletions.
diff --git a/Makefile b/Makefile
@@ -52,7 +52,7 @@ serve_docs:
 ################################
 
 api_docs:
-	@echo "Installing swagger-merger" && yarn global add swagger-merger
+	@echo "Installing swagger-merger" && npm install swagger-merger -g
 	@swagger-merger -i $(PWD)/swagger/index.yaml -o $(PWD)/docs/api_docs/bundle.yaml
 
 checks:

diff --git a/docs/api_docs/bundle.yaml b/docs/api_docs/bundle.yaml
@@ -4,7 +4,7 @@ info:
     Flagr is a feature flagging, A/B testing and dynamic configuration
     microservice. The base path for all the APIs is "/api/v1".
   title: Flagr
-  version: 1.1.0
+  version: 1.1.2
 tags:
   - name: flag
     description: Everything about the flag
@@ -759,7 +759,9 @@ paths:
       description: Check if Flagr is healthy
       responses:
         '200':
-          description: OK
+          description: status of health check
+          schema:
+            $ref: '#/definitions/health'
         default:
           description: generic error response
           schema:
@@ -1218,6 +1220,11 @@ definitions:
         type: array
         items:
           $ref: '#/definitions/evalResult'
+  health:
+    type: object
+    properties:
+      status:
+        type: string
   error:
     type: object
     required:

diff --git a/docs/home.md b/docs/home.md
@@ -37,7 +37,7 @@ Install Dependencies.
 
 - Go
 - Make (for Makefile)
-- Yarn (for building UI)
+- Yarn and NPM (for building UI)
 - SQLite3 (for testing)
 
 Build from source.

diff --git a/integration_tests/test.sh b/integration_tests/test.sh
@@ -12,6 +12,7 @@ step_1_test_health()
 
     shakedown GET $flagr_url/health
         status 200
+        content_type 'application/json'
 }
 
 step_2_test_crud_flag()

diff --git a/pkg/handler/handler.go b/pkg/handler/handler.go
@@ -3,6 +3,7 @@ package handler
 import (
 	"github.com/checkr/flagr/pkg/config"
 	"github.com/checkr/flagr/pkg/entity"
+	"github.com/checkr/flagr/swagger_gen/models"
 	"github.com/checkr/flagr/swagger_gen/restapi/operations"
 	"github.com/checkr/flagr/swagger_gen/restapi/operations/constraint"
 	"github.com/checkr/flagr/swagger_gen/restapi/operations/distribution"
@@ -83,7 +84,9 @@ func setupEvaluation(api *operations.FlagrAPI) {
 
 func setupHealth(api *operations.FlagrAPI) {
 	api.HealthGetHealthHandler = health.GetHealthHandlerFunc(
-		func(health.GetHealthParams) middleware.Responder { return &health.GetHealthOK{} },
+		func(health.GetHealthParams) middleware.Responder {
+			return health.NewGetHealthOK().WithPayload(&models.Health{Status: "OK"})
+		},
 	)
 }
 

diff --git a/swagger/health.yaml b/swagger/health.yaml
@@ -5,7 +5,9 @@ get:
   description: Check if Flagr is healthy
   responses:
     200:
-      description: OK
+      description: status of health check
+      schema:
+        $ref: "#/definitions/health"
     default:
       description: generic error response
       schema:

diff --git a/swagger/index.yaml b/swagger/index.yaml
@@ -5,7 +5,7 @@ info:
     Flagr is a feature flagging, A/B testing and dynamic configuration microservice.
     The base path for all the APIs is "/api/v1".
   title: Flagr
-  version: 1.1.0
+  version: 1.1.2
 tags:
   - name: flag
     description: Everything about the flag
@@ -507,6 +507,13 @@ definitions:
         items:
           $ref: "#/definitions/evalResult"
 
+  # Health check
+  health:
+    type: object
+    properties:
+      status:
+        type: string
+
   # Default Error
   error:
     type: object

diff --git a/swagger_gen/models/health.go b/swagger_gen/models/health.go
diff --git a/swagger_gen/restapi/doc.go b/swagger_gen/restapi/doc.go
diff --git a/swagger_gen/restapi/embedded_spec.go b/swagger_gen/restapi/embedded_spec.go
diff --git a/swagger_gen/restapi/operations/health/get_health_responses.go b/swagger_gen/restapi/operations/health/get_health_responses.go