Adds /health route to flights service (#83)

Kong · Aug 24, 2023 · be0cfc2 · be0cfc2
1 parent 17c8341
commit be0cfc2
Show file tree

Hide file tree

Showing 3 changed files with 60 additions and 16 deletions.
diff --git a/flight-data/flights/api/flights-server.gen.go b/flight-data/flights/api/flights-server.gen.go
diff --git a/flight-data/flights/api/flights.go b/flight-data/flights/api/flights.go
@@ -150,6 +150,10 @@ func NewFlightService() *FlightService {
 	return &rv
 }
 
+func (s *FlightService) GetHealth(ctx echo.Context) error {
+  return ctx.JSON(http.StatusOK, map[string]string{"status": "OK"})
+}
+
 func (s *FlightService) GetFlights(ctx echo.Context, params models.GetFlightsParams) error {
 	return ctx.JSON(http.StatusOK, s.Flights)
 }

diff --git a/flight-data/flights/openapi.yaml b/flight-data/flights/openapi.yaml
@@ -12,6 +12,31 @@ servers:
   description: KongAir API Server
 
 paths:
+  /health:
+    get:
+      summary: Health check endpoint for Kubernetes
+      description: Endpoint that returns the service health status.
+      responses:
+        '200':
+          description: Service is healthy
+          content:
+            application/json:
+              schema:
+                type: object
+                properties:
+                  status:
+                    type: string
+                    example: "OK"
+        '500':
+          description: Service is unhealthy
+          content:
+            application/json:
+              schema:
+                type: object
+                properties:
+                  status:
+                    type: string
+                    example: "unhealthy"
   "/flights":
     get:
       summary: Get KongAir planned flights