Skip to content

Commit

Permalink
Adjust documentation for service tags of checks
Browse files Browse the repository at this point in the history
Add some missing ServiceTags.
Replace null ServiceTags by empty list (ServiceTags cannot be null).
  • Loading branch information
yfouquet committed Dec 12, 2017
1 parent 986148c commit 16cc432
Show file tree
Hide file tree
Showing 4 changed files with 7 additions and 6 deletions.
3 changes: 2 additions & 1 deletion website/source/api/agent/check.html.md
Original file line number Diff line number Diff line change
Expand Up @@ -55,7 +55,8 @@ $ curl \
"Notes": "",
"Output": "",
"ServiceID": "redis",
"ServiceName": "redis"
"ServiceName": "redis",
"ServiceTags": ["primary"]
}
}
```
Expand Down
2 changes: 1 addition & 1 deletion website/source/api/agent/service.html.md
Original file line number Diff line number Diff line change
Expand Up @@ -51,7 +51,7 @@ $ curl \
"redis": {
"ID": "redis",
"Service": "redis",
"Tags": null,
"Tags": [],
"Address": "",
"Port": 8000
}
Expand Down
6 changes: 3 additions & 3 deletions website/source/api/health.html.md
Original file line number Diff line number Diff line change
Expand Up @@ -62,7 +62,7 @@ $ curl \
"Output": "",
"ServiceID": "",
"ServiceName": "",
"ServiceTags": null
"ServiceTags": []
},
{
"ID": "40e4a748-2192-161a-0510-9bf59fe950b5",
Expand Down Expand Up @@ -239,7 +239,7 @@ $ curl \
"Output": "",
"ServiceID": "",
"ServiceName": "",
"ServiceTags": null
"ServiceTags": []
}
]
}
Expand Down Expand Up @@ -303,7 +303,7 @@ $ curl \
"Output": "",
"ServiceID": "",
"ServiceName": "",
"ServiceTags": null
"ServiceTags": []
},
{
"Node": "foobar",
Expand Down
2 changes: 1 addition & 1 deletion website/source/intro/getting-started/checks.html.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down

0 comments on commit 16cc432

Please sign in to comment.