Merge pull request eclipse#139 from emattheis/issue-138

clarify difference between having no checks at all vs. no checks available
antoinesd · Sep 11, 2018 · 7b0d253 · 7b0d253
2 parents 42aaa2e + e0e6c95
commit 7b0d253
Showing 1 changed file with 25 additions and 5 deletions.
diff --git a/spec/src/main/asciidoc/protocol-wireformat.adoc b/spec/src/main/asciidoc/protocol-wireformat.adoc
@@ -130,7 +130,8 @@ Each provider MUST provide the REST/HTTP interaction, but MAY provide other prot
 == Health Check Procedures
 * A producer MUST support custom, application level health check procedures
 * A producer SHOULD support reasonable out-of-the-box procedures
-* A producer without health check procedures installed MUST returns positive overall status (i.e. HTTP 200)
+* A producer with no health check procedures expected or installed MUST return positive overall status (i.e. HTTP 200)
+* A producer with health check procedures expected but not yet installed MUST return negative overall status (i.e. HTTP 503)
 
 === Policies to determine the overall status
 
@@ -190,14 +191,20 @@ The following table give valid health check responses:
 | 200
 | Yes
 | UP
-| Check without procedures installed. See <<Without procedures installed into the runtime>>
+| Check with no procedures expected or installed. See <<With no procedures expected or installed into the runtime>>
 
 | /health
 | 503
 | Yes
 | Down
 | Check failed
 
+| /health
+| 503
+| Yes
+| Down
+| Check with procedures expected but not yet installed. See <<With procedures expected but not yet installed into the runtime>>
+
 | /health
 | 500
 | No
@@ -256,7 +263,8 @@ The following table give valid health check responses:
 == Example response payloads
 
 === With procedures installed into the runtime
-Status 200
+Status `200` and the following payload:
+
 ```
 {
   "status": "UP",
@@ -273,7 +281,8 @@ Status 200
 }
 ```
 
-Status 503
+Status `503` and the following payload:
+
 ```
 {
   "status": "DOWN",
@@ -314,7 +323,7 @@ Status 500
 }
 ```
 
-=== Without procedures installed into the runtime
+=== With no procedures expected or installed into the runtime
 
 Status `200` and the following payload:
 
@@ -324,3 +333,14 @@ Status `200` and the following payload:
   "checks": []
 }
 ```
+
+=== With procedures expected but not yet installed into the runtime
+
+Status `503` and the following payload:
+
+```
+{
+  "status": "DOWN",
+  "checks": []
+}
+```