Rename /health/start to /health/started?

eclipse / microprofile-health

microprofile-health

Apache License 2.0

106 stars 61 forks source link

Rename /health/start to /health/started? #302

Closed xstefank closed 3 years ago

xstefank commented 3 years ago

In the GG dicsussion there was a concern raised that /health/start is not sufficiently aligned with /health/live and /health/ready because these two endpoints end with adjectives where "start" is a verb. The proposed change is to rename /health/start to /health/started.

cc @Ladicek @tjquinno

Ladicek commented 3 years ago

English is hard :-) AFAIK, "live" can be an adjective, a verb and an adverb [1]. Similarly, "ready" can be an adjective as well as a verb. Finally, "start" can be a noun and a verb.

That said, my feeling has always been that the term in /health/whatever is an adjective. Hence I think we should use "started" for the startup probe.

[1] One could even argue that we should have used "alive" instead, which is unambiguously an adjective :grin:

tjquinno commented 3 years ago

@Ladicek Indeed!

I completely agree with you that using adjectives consistently is clearest and most natural.

While you're certainly correct that these words are "overloaded" in English as you described, I think it's fair to say that:

"ready" is by far most often used as an adjective (and that is reinforced by the context here)
"live," given the context here, is pretty clearly used as an adjective [1]
"start" is never an adjective!

I wholeheartedly agree about preferring started to start for the path.

Ladicek commented 3 years ago

(I probably should have added that, just like @xstefank, I'm not a native speaker :grin:)

tjquinno commented 3 years ago

You two, along with many of my colleagues, collaborators, and contacts who are also non-native English speakers, have my deep respect. If I had to communicate professionally using my long-dormant French-speaking "skills" I would be in deep trouble!

pgunapal commented 3 years ago

Just got a chance to look at this issue and proposed PR, just my thoughts...

If we are going to rename it to /health/started (no objections on my end.), and MP 4.1 is already delayed, should we do a Doodle poll again for the endpoint name, so we get a wider audience input on it? Personally, since we went away with the names being consistent with the existing names for Startup, should we just name it /health/startup, as startup is an adjective? What do you guys think?

xstefank commented 3 years ago

MP 4.1 will be delayed only because of the Health release which will be respun with this change. An additional doodle poll will introduce further delays. As I said in the GG, /health/startup will introduce questions why it isn't /health/liveness and /health/readiness I believe.

pgunapal commented 3 years ago

Understood, that makes sense. I am okay with /health/started, as that's the next best option.