mirror of https://github.com/status-im/consul.git
Fix typo in check update endpoints
The current website says that you can send output with the update of a check using the `?node` parameter. It wasn't working and I check [the source](3874498374/command/agent/agent_endpoint.go (L110)
) to find that it was (the more logical noun of) note! I changed the indication to replace `?node` for `?note`
This commit is contained in:
parent
b4c2f49676
commit
e7b5f29191
|
@ -420,7 +420,7 @@ This endpoint is used with a check that is of the [TTL type](/docs/agent/checks.
|
||||||
When this endpoint is accessed via a GET, the status of the check is set to "passing",
|
When this endpoint is accessed via a GET, the status of the check is set to "passing",
|
||||||
and the TTL clock is reset.
|
and the TTL clock is reset.
|
||||||
|
|
||||||
The optional "?node=" query parameter can be used to associate output with
|
The optional "?note=" query parameter can be used to associate output with
|
||||||
the status of the check. This should be human readable for operators.
|
the status of the check. This should be human readable for operators.
|
||||||
|
|
||||||
The return code is 200 on success.
|
The return code is 200 on success.
|
||||||
|
@ -431,7 +431,7 @@ This endpoint is used with a check that is of the [TTL type](/docs/agent/checks.
|
||||||
When this endpoint is accessed via a GET, the status of the check is set to "warning",
|
When this endpoint is accessed via a GET, the status of the check is set to "warning",
|
||||||
and the TTL clock is reset.
|
and the TTL clock is reset.
|
||||||
|
|
||||||
The optional "?node=" query parameter can be used to associate output with
|
The optional "?note=" query parameter can be used to associate output with
|
||||||
the status of the check. This should be human readable for operators.
|
the status of the check. This should be human readable for operators.
|
||||||
|
|
||||||
The return code is 200 on success.
|
The return code is 200 on success.
|
||||||
|
@ -442,7 +442,7 @@ This endpoint is used with a check that is of the [TTL type](/docs/agent/checks.
|
||||||
When this endpoint is accessed via a GET, the status of the check is set to "critical",
|
When this endpoint is accessed via a GET, the status of the check is set to "critical",
|
||||||
and the TTL clock is reset.
|
and the TTL clock is reset.
|
||||||
|
|
||||||
The optional "?node=" query parameter can be used to associate output with
|
The optional "?note=" query parameter can be used to associate output with
|
||||||
the status of the check. This should be human readable for operators.
|
the status of the check. This should be human readable for operators.
|
||||||
|
|
||||||
The return code is 200 on success.
|
The return code is 200 on success.
|
||||||
|
|
Loading…
Reference in New Issue