From 8455f222853780a8353672b5fbc921b5bfce17db Mon Sep 17 00:00:00 2001 From: Gyuho Lee Date: Wed, 17 Jan 2018 14:32:47 -0800 Subject: [PATCH] Documentation/upgrades: highlight "health", remove "errors" field Signed-off-by: Gyuho Lee --- Documentation/upgrades/upgrade_3_3.md | 16 +++------------- 1 file changed, 3 insertions(+), 13 deletions(-) diff --git a/Documentation/upgrades/upgrade_3_3.md b/Documentation/upgrades/upgrade_3_3.md index b725aefcf..f1be1619b 100644 --- a/Documentation/upgrades/upgrade_3_3.md +++ b/Documentation/upgrades/upgrade_3_3.md @@ -72,27 +72,17 @@ cfg.SetupLogging() Set `embed.Config.Debug` field to `true` to enable gRPC server logs. -#### Change in `/health` endpoint response value +#### Change in `/health` endpoint response -Previously, `[endpoint]:[client-port]/health` returned manually marshaled JSON value. 3.3 now defines [`etcdhttp.Health`](https://godoc.org/github.com/coreos/etcd/etcdserver/api/etcdhttp#Health) struct and includes errors, if any. Note that `"health"` field in `etcdhttp.Health` is `string` type (was boolean in v3.3.0-rc.0,1,2 but reverted to `string` for backward compatibilities). +Previously, `[endpoint]:[client-port]/health` returned manually marshaled JSON value. 3.3 now defines [`etcdhttp.Health`](https://godoc.org/github.com/coreos/etcd/etcdserver/api/etcdhttp#Health) struct. -Before +Note that in v3.3.0-rc.0, v3.3.0-rc.1, and v3.3.0-rc.2, `etcdhttp.Health` has boolean type `"health"` and `"errors"` fields. For backward compatibilities, we reverted `"health"` field to `string` type and removed `"errors"` field. Further health information will be provided in separate APIs. ```bash $ curl http://localhost:2379/health {"health":"true"} ``` -After - -```bash -$ curl http://localhost:2379/health -{"health":"true"} - -# Or -{"health":"false","errors":["NOSPACE"]} -``` - #### Change in gRPC gateway HTTP endpoints (replaced `/v3alpha` with `/v3beta`) Before