From 0e35b10683ee276846af0d181b0f93f89ff907b6 Mon Sep 17 00:00:00 2001 From: Alvin Huang Date: Thu, 6 Dec 2018 10:59:43 -0500 Subject: [PATCH 1/2] clarify how `separator` should be in CLI and API --- website/source/api/kv.html.md | 7 ++++--- website/source/docs/commands/kv/get.html.markdown.erb | 6 +++--- 2 files changed, 7 insertions(+), 6 deletions(-) diff --git a/website/source/api/kv.html.md b/website/source/api/kv.html.md index 5514a78e1..e4723b6d1 100644 --- a/website/source/api/kv.html.md +++ b/website/source/api/kv.html.md @@ -62,9 +62,10 @@ The table below shows this endpoint's support for metadata). Specifying this implies `recurse`. This is specified as part of the URL as a query parameter. -- `separator` `(string: '/')` - Specifies the character to use as a separator - for recursive lookups. This is specified as part of the URL as a query - parameter. +- `separator` `(string: '/')` - Specifies the string to use as a separator + for recursive key lookups. This option is only used when paired with the `keys` + parameter to limit the dept of keys returned, only up to the given separator. + This is specified as part of the URL as a query parameter. ### Sample Request diff --git a/website/source/docs/commands/kv/get.html.markdown.erb b/website/source/docs/commands/kv/get.html.markdown.erb index afe5b7f80..6f4738364 100644 --- a/website/source/docs/commands/kv/get.html.markdown.erb +++ b/website/source/docs/commands/kv/get.html.markdown.erb @@ -38,9 +38,9 @@ Usage: `consul kv get [options] [KEY_OR_PREFIX]` * `-recurse` - Recursively look at all keys prefixed with the given path. The default value is false. -* `-separator=` - String to use as a separator between keys. The default - value is "/", but this option is only taken into account when paired with the - -keys flag. +* `-separator=` - String to use as a separator for recursive lookups. The + default value is "/", and only used when paired with the `-keys` flag. This will + limit the depth of keys returned, only up to the given separator. ## Examples From 10c5b84a648ca1f35d89b26badb2bb0449d10e86 Mon Sep 17 00:00:00 2001 From: Alvin Huang Date: Fri, 7 Dec 2018 14:57:00 -0500 Subject: [PATCH 2/2] change depth to prefix --- website/source/api/kv.html.md | 2 +- website/source/docs/commands/kv/get.html.markdown.erb | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/website/source/api/kv.html.md b/website/source/api/kv.html.md index e4723b6d1..339e6e7d7 100644 --- a/website/source/api/kv.html.md +++ b/website/source/api/kv.html.md @@ -64,7 +64,7 @@ The table below shows this endpoint's support for - `separator` `(string: '/')` - Specifies the string to use as a separator for recursive key lookups. This option is only used when paired with the `keys` - parameter to limit the dept of keys returned, only up to the given separator. + parameter to limit the prefix of keys returned, only up to the given separator. This is specified as part of the URL as a query parameter. ### Sample Request diff --git a/website/source/docs/commands/kv/get.html.markdown.erb b/website/source/docs/commands/kv/get.html.markdown.erb index 6f4738364..a47d17b65 100644 --- a/website/source/docs/commands/kv/get.html.markdown.erb +++ b/website/source/docs/commands/kv/get.html.markdown.erb @@ -40,7 +40,7 @@ Usage: `consul kv get [options] [KEY_OR_PREFIX]` * `-separator=` - String to use as a separator for recursive lookups. The default value is "/", and only used when paired with the `-keys` flag. This will - limit the depth of keys returned, only up to the given separator. + limit the prefix of keys returned, only up to the given separator. ## Examples