From 16cc432c7a86e45da6141f177c15a167af31d07e Mon Sep 17 00:00:00 2001 From: Yoann Fouquet Date: Thu, 23 Nov 2017 22:16:42 +0100 Subject: [PATCH] Adjust documentation for service tags of checks Add some missing ServiceTags. Replace null ServiceTags by empty list (ServiceTags cannot be null). --- website/source/api/agent/check.html.md | 3 ++- website/source/api/agent/service.html.md | 2 +- website/source/api/health.html.md | 6 +++--- website/source/intro/getting-started/checks.html.md | 2 +- 4 files changed, 7 insertions(+), 6 deletions(-) diff --git a/website/source/api/agent/check.html.md b/website/source/api/agent/check.html.md index da64214c70..f76c1e7618 100644 --- a/website/source/api/agent/check.html.md +++ b/website/source/api/agent/check.html.md @@ -55,7 +55,8 @@ $ curl \ "Notes": "", "Output": "", "ServiceID": "redis", - "ServiceName": "redis" + "ServiceName": "redis", + "ServiceTags": ["primary"] } } ``` diff --git a/website/source/api/agent/service.html.md b/website/source/api/agent/service.html.md index 62670311e2..eaf909f36f 100644 --- a/website/source/api/agent/service.html.md +++ b/website/source/api/agent/service.html.md @@ -51,7 +51,7 @@ $ curl \ "redis": { "ID": "redis", "Service": "redis", - "Tags": null, + "Tags": [], "Address": "", "Port": 8000 } diff --git a/website/source/api/health.html.md b/website/source/api/health.html.md index 05508a11dc..6f1639bb50 100644 --- a/website/source/api/health.html.md +++ b/website/source/api/health.html.md @@ -62,7 +62,7 @@ $ curl \ "Output": "", "ServiceID": "", "ServiceName": "", - "ServiceTags": null + "ServiceTags": [] }, { "ID": "40e4a748-2192-161a-0510-9bf59fe950b5", @@ -239,7 +239,7 @@ $ curl \ "Output": "", "ServiceID": "", "ServiceName": "", - "ServiceTags": null + "ServiceTags": [] } ] } @@ -303,7 +303,7 @@ $ curl \ "Output": "", "ServiceID": "", "ServiceName": "", - "ServiceTags": null + "ServiceTags": [] }, { "Node": "foobar", diff --git a/website/source/intro/getting-started/checks.html.md b/website/source/intro/getting-started/checks.html.md index d4e37c4b86..f3b79f1b39 100644 --- a/website/source/intro/getting-started/checks.html.md +++ b/website/source/intro/getting-started/checks.html.md @@ -75,7 +75,7 @@ can be run on either node): ```text vagrant@n1:~$ curl http://localhost:8500/v1/health/state/critical -[{"Node":"agent-two","CheckID":"service:web","Name":"Service 'web' check","Status":"critical","Notes":"","ServiceID":"web","ServiceName":"web"}] +[{"Node":"agent-two","CheckID":"service:web","Name":"Service 'web' check","Status":"critical","Notes":"","ServiceID":"web","ServiceName":"web","ServiceTags":["rails"]}] ``` We can see that there is only a single check, our `web` service check, in the