feat: add name and version to GET /__health endpoint (#238)

Author: UlisesGascon

__tests__/httpServer/apiV1.test.js

@@ -1,5 +1,6 @@
 const request = require('supertest')
 const { generateStaticReports } = require('../../src/reports')
+const pkg = require('../../package.json')
 const serverModule = require('../../src/httpServer')
 let server
 let serverStop
@@ -35,6 +36,8 @@ describe('HTTP Server API V1', () => {
       expect(response.status).toBe(200)
       expect(response.body).toHaveProperty('status', 'ok')
       expect(response.body).toHaveProperty('timestamp')
+      expect(response.body).toHaveProperty('version', pkg.version)
+      expect(response.body).toHaveProperty('name', pkg.name)
 
       const timestamp = new Date(response.body.timestamp)
       expect(timestamp.toISOString()).toBe(response.body.timestamp)

src/httpServer/routers/apiV1.js

@@ -1,11 +1,12 @@
 const { generateStaticReports } = require('../../reports')
+const pkg = require('../../../package.json')
 const { logger } = require('../../utils')
 
 function createApiRouter (knex, express) {
   const router = express.Router()
 
   router.get('/__health', (req, res) => {
-    res.json({ status: 'ok', timestamp: new Date().toISOString() })
+    res.json({ status: 'ok', timestamp: new Date().toISOString(), version: pkg.version, name: pkg.name })
   })
 
   router.post('/generate-reports', async (req, res) => {

src/httpServer/swagger/api-v1.yml

@@ -28,9 +28,17 @@ paths:
                     type: string
                     format: date-time
                     example: '2025-05-03T07:20:16.000Z'
+                  name:
+                    type: string
+                    example: visionboard
+                  version:
+                    type: string
+                    example: 1.0.0
                 required:
                   - status
                   - timestamp
+                  - name
+                  - version
 
   /api/v1/generate-reports:
     post: