Skip to content

Commit a7faabe

Browse files
committed
Merge pull request #304 from xstefank/issue-302
Rename /health/start to /health/started
2 parents 403170e + 33d41dc commit a7faabe

8 files changed

Lines changed: 15 additions & 14 deletions

File tree

spec/src/main/asciidoc/overview.asciidoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -27,7 +27,7 @@ https://kubernetes.io/docs/tasks/configure-pod-container/configure-liveness-read
2727

2828
In this scenario health checks are used to determine if a computing node needs to be discarded (terminated, shutdown) and eventually replaced by another (healthy) instance.
2929

30-
The MicroProfile Health architecture consists of three `/health/ready`, `/health/live` and `/health/start` endpoints in a MicroProfile runtime that respectively represent the readiness, the liveness and the startup health of the entire runtime.
30+
The MicroProfile Health architecture consists of three `/health/ready`, `/health/live` and `/health/started` endpoints in a MicroProfile runtime that respectively represent the readiness, the liveness and the startup health of the entire runtime.
3131
These endpoints are linked to health check procedures defined with specifications API and annotated respectively with `@Readiness`, `@Liveness` and `@Startup` annotations.
3232

3333
A 4th endpoint `/health` is also available and can be used to provide a combination of the previous endpoints.

spec/src/main/asciidoc/protocol-wireformat.asciidoc

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -225,7 +225,7 @@ Aspects regarding the secure access of health check information.
225225
| Readiness
226226
| See Appendix B
227227

228-
| /health/start
228+
| /health/started
229229
| GET
230230
| 200, 500, 503
231231
| Startup
@@ -255,7 +255,7 @@ The following table gives valid health check responses for all kinds of health c
255255
| Request | HTTP Status | JSON Payload | Status | Comment
256256
| /health/live
257257
/health/ready
258-
/health/start
258+
/health/started
259259
/health
260260
| 200
261261
| Yes
@@ -264,7 +264,7 @@ The following table gives valid health check responses for all kinds of health c
264264

265265
| /health/live
266266
/health/ready
267-
/health/start
267+
/health/started
268268
/health
269269
| 200
270270
| Yes
@@ -273,7 +273,7 @@ The following table gives valid health check responses for all kinds of health c
273273

274274
| /health/live
275275
/health/ready
276-
/health/start
276+
/health/started
277277
/health
278278
| 503
279279
| Yes
@@ -282,7 +282,7 @@ The following table gives valid health check responses for all kinds of health c
282282

283283
| /health/live
284284
/health/ready
285-
/health/start
285+
/health/started
286286
/health
287287
| 503
288288
| Yes
@@ -291,7 +291,7 @@ The following table gives valid health check responses for all kinds of health c
291291

292292
| /health/live
293293
/health/ready
294-
/health/start
294+
/health/started
295295
/health
296296
| 500
297297
| No

spec/src/main/asciidoc/release_notes.asciidoc

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -34,6 +34,7 @@ A full list of changes may be found on the link:https://github.com/eclipse/micro
3434
=== API/SPI Changes
3535

3636
- Added `@Startup` qualifier for the Kubernetes startup probes health check procedures (https://github.com/eclipse/microprofile-health/issues/274[#274])
37+
- Introduction of `/health/started` endpoint that must call all the startup procedures
3738

3839
=== Functional Changes
3940

tck/src/main/java/org/eclipse/microprofile/health/tck/CDIProducedProceduresTest.java

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -37,7 +37,7 @@
3737
/**
3838
* Verifies the liveness, readiness, and startup health integration with CDI when the Health Check procedures are
3939
* defined with CDI method Producers.
40-
*
40+
*
4141
* @author Prashanth Gunapalasingam
4242
*/
4343
public class CDIProducedProceduresTest extends TCKBase {
@@ -99,7 +99,7 @@ public void testFailureReadinessResponsePayload() {
9999
@Test
100100
@RunAsClient
101101
public void testSuccessStartupResponsePayload() {
102-
Response response = getUrlStartContents();
102+
Response response = getUrlStartedContents();
103103

104104
// status code
105105
Assert.assertEquals(response.getStatus(), 200);

tck/src/main/java/org/eclipse/microprofile/health/tck/MultipleStartupFailedTest.java

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -53,7 +53,7 @@ public static Archive getDeployment() {
5353
@Test
5454
@RunAsClient
5555
public void testFailingStartupResponsePayload() {
56-
Response response = getUrlStartContents();
56+
Response response = getUrlStartedContents();
5757

5858
// status code
5959
Assert.assertEquals(response.getStatus(), 503);

tck/src/main/java/org/eclipse/microprofile/health/tck/SingleStartupFailedTest.java

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -49,7 +49,7 @@ public static Archive getDeployment() {
4949
@Test
5050
@RunAsClient
5151
public void testFailedResponsePayload() {
52-
Response response = getUrlStartContents();
52+
Response response = getUrlStartedContents();
5353

5454
// status code
5555
Assert.assertEquals(response.getStatus(), 503);

tck/src/main/java/org/eclipse/microprofile/health/tck/SingleStartupSuccessfulTest.java

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -49,7 +49,7 @@ public static Archive getDeployment() {
4949
@Test
5050
@RunAsClient
5151
public void testSuccessResponsePayload() {
52-
Response response = getUrlStartContents();
52+
Response response = getUrlStartedContents();
5353

5454
// status code
5555
Assert.assertEquals(response.getStatus(), 200);

tck/src/main/java/org/eclipse/microprofile/health/tck/TCKBase.java

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -75,8 +75,8 @@ Response getUrlReadyContents() {
7575
return getUrlContents(this.uri + "/health/ready", false);
7676
}
7777

78-
Response getUrlStartContents() {
79-
return getUrlContents(this.uri + "/health/start", false);
78+
Response getUrlStartedContents() {
79+
return getUrlContents(this.uri + "/health/started", false);
8080
}
8181

8282
private Response getUrlContents(String theUrl, boolean useAuth) {

0 commit comments

Comments
 (0)