@databricks-solutions/lakebase-scm-utils 0.2.45 → 0.2.47

package/templates/project/nodejs/src/routes/health.js

@@ -1,6 +1,24 @@
 const express = require('express');
 const router = express.Router();
 
+/**
+ * @openapi
+ * /health:
+ *   get:
+ *     summary: Liveness probe
+ *     description: Returns ok when the service is up. Pattern for annotating routes so they appear in /docs.
+ *     responses:
+ *       200:
+ *         description: Service is up
+ *         content:
+ *           application/json:
+ *             schema:
+ *               type: object
+ *               properties:
+ *                 status:
+ *                   type: string
+ *                   example: ok
+ */
 router.get('/health', (req, res) => {
   res.json({ status: 'ok' });
 });

package/templates/project/nodejs/tests/app.test.js

@@ -8,3 +8,19 @@ describe('Health check', () => {
     expect(res.body.status).toBe('ok');
   });
 });
+
+describe('API docs (Swagger UI for acceptance review)', () => {
+  test('GET /openapi.json exposes the OpenAPI spec, including annotated routes', async () => {
+    const res = await request(app).get('/openapi.json');
+    expect(res.statusCode).toBe(200);
+    expect(res.body.openapi).toBeDefined();
+    // The @openapi annotation on the health route is picked up by swagger-jsdoc.
+    expect(res.body.paths['/health']).toBeDefined();
+  });
+
+  test('GET /docs/ serves the Swagger UI', async () => {
+    const res = await request(app).get('/docs/');
+    expect(res.statusCode).toBe(200);
+    expect(res.text).toMatch(/swagger-ui/i);
+  });
+});