From 895a0527391cd4912d09058286e7dbe56a715406 Mon Sep 17 00:00:00 2001 From: wisa Date: Mon, 13 May 2019 10:21:29 +0200 Subject: [PATCH] #13 review health page --- src/main/asciidoc/health.adoc | 2 +- src/main/asciidoc/swagger/health-swagger.yaml | 3 +++ 2 files changed, 4 insertions(+), 1 deletion(-) diff --git a/src/main/asciidoc/health.adoc b/src/main/asciidoc/health.adoc index 8b95851..cbc1569 100644 --- 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 index 55a994c..ab0029b 100644 --- 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