status-im
/
consul
mirror of https://github.com/status-im/consul.git
2
0
Fork 0
Code Issues Projects Releases Wiki Activity

Merge pull request #2674 from oliora/master 

Fix missing query parameters formatting in HTTP API documentation
This commit is contained in:
Kyle Havlovitz 2017-01-25 14:07:42 -05:00 committed by GitHub
parent 4c1a156417 f6c6a9ff3e
commit 01ed54723f
2 changed files with 3 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

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

@ -113,7 +113,7 @@ time from that node. Passing `?near=_agent` will use the agent's
node for the sort.
By default, all nodes matching the service are returned. The list can be filtered
by tag using the "?tag=" query parameter.
by tag using the `?tag=` query parameter.
Providing the `?passing` query parameter, added in Consul 0.2, will
filter results to only nodes with all checks in the `passing` state.

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

@ -66,7 +66,7 @@ be used to establish blocking queries by setting the `?index` query parameter.
You can even perform blocking queries against entire subtrees of the KV store:
if `?recurse` is provided, the returned `X-Consul-Index` corresponds
to the latest `ModifyIndex` within the prefix, and a blocking query using that
"?index" will wait until any key within that prefix is updated.
`?index` will wait until any key within that prefix is updated.
`LockIndex` is the number of times this key has successfully been acquired in
a lock. If the lock is held, the `Session` key provides the session that owns
@ -129,7 +129,7 @@ be used with a `PUT` request:
contents without having to give up the lock and reacquire it.
* `?release=<session>` : This flag is used to turn the `PUT` into a lock release
operation. This is useful when paired with "?acquire=" as it allows clients to
operation. This is useful when paired with `?acquire=` as it allows clients to
yield a lock. This will leave the `LockIndex` unmodified but will clear the associated
`Session` of the key. The key must be held by this session to be unlocked.