#13 review health page

belgif · May 13, 2019 · 895a052 · 895a052
1 parent 00494de
commit 895a052
Show file tree

Hide file tree

Showing 2 changed files with 4 additions and 1 deletion.
diff --git a/src/main/asciidoc/health.adoc b/src/main/asciidoc/health.adoc
@@ -2,7 +2,7 @@
 
 Each REST API exposes a health resource which simply returns the current status of the service.
 
-When invoked without any access token, the resource simply returns its status. The status code is either ```200 OK``` when the service is up or partialy available, or `503 Service Unavailable' when the service is down or out of service.
+When invoked without any access token, the resource simply returns its status. The status code is either ```200 OK``` when the service is up or partialy available, or `503 Service Unavailable` when the service is down or out of service.
 
 .Sample service is up
 ```json

diff --git a/src/main/asciidoc/swagger/health-swagger.yaml b/src/main/asciidoc/swagger/health-swagger.yaml
@@ -71,6 +71,9 @@ definitions:
     properties:
       status:
         $ref: "#/definitions/HealthLevel"
+      message:
+        description: Optional description clarifying the health status of the component
+        type: string
   HealthLevel:
     description: Level indicating the health status of the service
     type: string