chore: Adapt reference for /health to the latest refactoring

api-spec/healthapi.yaml

@@ -1,17 +1,16 @@
 get:
   summary: Get node health status
-  description: Retrieve readiness of a Waku v2 node.
+  description: Retrieve status of a Waku v2 node.
   operationId: healthcheck
   tags:
     - health
   responses:
     '200':
-      description: Waku v2 node is up and running.
+      description: Health report of a Waku v2 node and its protocols.
       content:
-        text/plain:
-            schema:
-              type: string
-              example: Node is healty
+        application/json:
+          schema:
+            $ref: "./schemas/apitypes.yaml#/HealthReport"              
     '500':
       description: Internal server error
       content:

api-spec/openapi.yaml

@@ -1,4 +1,4 @@
-openapi: 3.0.3
+openapi: 3.1.0
 info:
   title: Waku V2 node REST API
   version: 1.0.0

api-spec/schemas/apitypes.yaml

@@ -252,3 +252,26 @@ FilterSubscription:
             type: string
           contentTopic:
             type: string
+
+HealthStatus:
+  type: string
+  enum:
+    - "Initializing"
+    - "Synchronizing"
+    - "Ready"
+    - "Not Ready"
+    - "Not Mounted"
+    - "Shutting Down"
+
+HealthReport:
+  type: object
+  properties:
+    nodeHealth:
+      $ref: '#/HealthStatus'
+      description: Overall health status of the node
+    protocolsHealth:
+      type: array
+      items:
+        type: object
+        additionalProperties:
+          $ref: '#/HealthStatus'