From f6c6a9ff3e468f9ce6815b003d747bb88f3c1b0d Mon Sep 17 00:00:00 2001 From: Andrey Upadyshev Date: Wed, 25 Jan 2017 14:34:56 +0100 Subject: [PATCH] Fix missing query parameters formatting in HTTP API documentation --- website/source/docs/agent/http/health.html.markdown | 2 +- website/source/docs/agent/http/kv.html.markdown | 4 ++-- 2 files changed, 3 insertions(+), 3 deletions(-) diff --git a/website/source/docs/agent/http/health.html.markdown b/website/source/docs/agent/http/health.html.markdown index eb669cda9e..8481d13977 100644 --- a/website/source/docs/agent/http/health.html.markdown +++ b/website/source/docs/agent/http/health.html.markdown @@ -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. diff --git a/website/source/docs/agent/http/kv.html.markdown b/website/source/docs/agent/http/kv.html.markdown index 20794a5abd..69c0577909 100644 --- a/website/source/docs/agent/http/kv.html.markdown +++ b/website/source/docs/agent/http/kv.html.markdown @@ -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=` : 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.