luxolus
/
open-consul
2
0
Fork 0
Code Issues 1 Pull Requests Packages Releases Wiki Activity

Remove references to the 'unknown' state. 

- Remove reference to 'unknown' state in catalog endpoint docs
- Remove reference to 'unknown' state in health endpoint docs
This commit is contained in:
Brian Shumate 2016-09-21 09:50:12 -04:00
parent e59ed0c97a
commit af45d3463a
No known key found for this signature in database
GPG Key ID: B2E211633F870928
2 changed files with 2 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
website/source/docs/agent/http/catalog.html.markdown
View File

@ -88,9 +88,7 @@ The `CheckID` can be omitted and will default to the value of `Name`. As with `S
the `CheckID` must be unique on this node. `Notes` is an opaque field that is meant to the `CheckID` must be unique on this node. `Notes` is an opaque field that is meant to
hold human-readable text. If a `ServiceID` is provided that matches the `ID` hold human-readable text. If a `ServiceID` is provided that matches the `ID`
of a service on that node, the check is treated as a service level health of a service on that node, the check is treated as a service level health
check, instead of a node level health check. The `Status` must be one of check, instead of a node level health check. The `Status` must be one of `passing`, `warning`, or `critical`.
`unknown`, `passing`, `warning`, or `critical`. The `unknown` status is used
to indicate that the initial check has not been performed yet.
Multiple checks can be provided by replacing `Check` with `Checks` and sending Multiple checks can be provided by replacing `Check` with `Checks` and sending
an array of `Check` objects. an array of `Check` objects.

2
website/source/docs/agent/http/health.html.markdown
View File

@ -179,7 +179,7 @@ the node list in ascending order based on the estimated round trip
time from that node. Passing "?near=_agent" will use the agent's time from that node. Passing "?near=_agent" will use the agent's
node for the sort. node for the sort.
The supported states are `any`, `unknown`, `passing`, `warning`, or `critical`. The supported states are `any`, `passing`, `warning`, or `critical`.
The `any` state is a wildcard that can be used to return all checks. The `any` state is a wildcard that can be used to return all checks.
It returns a JSON body like this: It returns a JSON body like this: