Add health check endpoints to commons (#138)

* Add health check endpoints to commons

* Hack to hopefully rename healthcheck.yaml to healthCheck.yaml

* Rename plop.yaml to healthCheck.yaml

* Fix typo

Author: tschaffter

.gitignore

@@ -1,4 +1,6 @@
+.idea
 dist
-dist.yaml
 node_modules
+
+dist.yaml
 openapi.yaml

openapi/commons/components/schemas/HealthCheck.yaml

@@ -0,0 +1,12 @@
+type: object
+description: Represents the health of a service
+properties:
+  status:
+    description: Indicates whether the service status is acceptable or not
+    type: string
+    enum:
+      - pass
+      - fail
+      - warn
+required:
+  - status

openapi/commons/paths/healthCheck.yaml

@@ -0,0 +1,15 @@
+get:
+  tags:
+    - HealthCheck
+  summary: Get health check information
+  description: Get information about the health of the service
+  operationId: getHealthCheck
+  responses:
+    '200':
+      description: Success
+      content:
+        application/json:
+          schema:
+            $ref: ../components/schemas/HealthCheck.yaml
+    '404':
+      $ref: ../components/responses/NotFound.yaml

openapi/data-node/openapi.yaml

@@ -33,6 +33,8 @@ tags:
     description: Operations about datasets
   - name: FhirStore
     description: Operations about FHIR stores
+  - name: HealthCheck
+    description: Operations about health checks
   - name: Note
     description: Operations about notes
   - name: Patient
@@ -72,5 +74,7 @@ paths:
     $ref: 'paths/notes.yaml'
   /datasets/{datasetId}/fhirStores/{fhirStoreId}/fhir/Note/{noteId}:
     $ref: 'paths/notes@{noteId}.yaml'
+  /healthCheck:
+    $ref: '../commons/paths/healthCheck.yaml'
   /service:
     $ref: '../commons/paths/service.yaml'