feat: Add health check endpoint for API status monitoring

Author: Lasim

services/backend/api-spec.json

@@ -91,6 +91,41 @@
         }
       }
     },
+    "/api/health": {
+      "get": {
+        "summary": "Simple API health check",
+        "tags": [
+          "Health Check"
+        ],
+        "description": "Returns basic API health status for monitoring, load balancers, and uptime checks",
+        "responses": {
+          "200": {
+            "description": "Simple health check response",
+            "content": {
+              "application/json": {
+                "schema": {
+                  "type": "object",
+                  "properties": {
+                    "status": {
+                      "type": "string",
+                      "enum": [
+                        "ok"
+                      ],
+                      "description": "Health status indicator"
+                    }
+                  },
+                  "required": [
+                    "status"
+                  ],
+                  "additionalProperties": false,
+                  "description": "Simple health check response"
+                }
+              }
+            }
+          }
+        }
+      }
+    },
     "/api/db/status": {
       "get": {
         "summary": "Get database status",

services/backend/api-spec.yaml

@@ -62,6 +62,30 @@ paths:
                   - version
                 additionalProperties: false
                 description: API health check information
+  /api/health:
+    get:
+      summary: Simple API health check
+      tags:
+        - Health Check
+      description: Returns basic API health status for monitoring, load balancers, and
+        uptime checks
+      responses:
+        "200":
+          description: Simple health check response
+          content:
+            application/json:
+              schema:
+                type: object
+                properties:
+                  status:
+                    type: string
+                    enum:
+                      - ok
+                    description: Health status indicator
+                required:
+                  - status
+                additionalProperties: false
+                description: Simple health check response
   /api/db/status:
     get:
       summary: Get database status

services/backend/src/routes/health/index.ts

@@ -0,0 +1,27 @@
+import { type FastifyInstance } from 'fastify'
+import { z } from 'zod'
+import { zodToJsonSchema } from 'zod-to-json-schema'
+
+// Response schema for the simple health check endpoint
+const healthResponseSchema = z.object({
+  status: z.literal('ok').describe('Health status indicator')
+});
+
+export default async function healthRoute(server: FastifyInstance) {
+  // Simple health check endpoint for monitoring/load balancers
+  server.get('/health', {
+    schema: {
+      tags: ['Health Check'],
+      summary: 'Simple API health check',
+      description: 'Returns basic API health status for monitoring, load balancers, and uptime checks',
+      response: {
+        200: zodToJsonSchema(healthResponseSchema.describe('Simple health check response'), {
+          $refStrategy: 'none',
+          target: 'openApi3'
+        })
+      }
+    }
+  }, async () => {
+    return { status: 'ok' }
+  });
+}

services/backend/src/routes/index.ts

@@ -13,6 +13,8 @@ import globalSettingsRoute from './globalSettings'
 import teamsRoute from './teams'
 // Import cloud credentials routes
 import cloudCredentialsRoute from './cloud-credentials'
+// Import health check route
+import healthRoute from './health'
 
 // Response schema for the root health check endpoint
 const healthCheckResponseSchema = z.object({
@@ -25,6 +27,9 @@ const healthCheckResponseSchema = z.object({
 export const registerRoutes = (server: FastifyInstance): void => {
   // Register all API routes with centralized /api prefix
   server.register(async (apiInstance) => {
+    // Register health check route
+    await apiInstance.register(healthRoute);
+
     // Register the individual database setup routes
     await apiInstance.register(dbStatusRoute);
     await apiInstance.register(dbSetupRoute);