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

clarify how `separator` should be in CLI and API

This commit is contained in:
Alvin Huang 2018-12-06 10:59:43 -05:00
parent 43d882c38e
commit b1823e428a
2 changed files with 7 additions and 6 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

7
website/source/api/kv.html.md
View File

@ -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 metadata). Specifying this implies `recurse`. This is specified as part of the
URL as a query parameter. URL as a query parameter.
- `separator` `(string: '/')` - Specifies the character to use as a separator - `separator` `(string: '/')` - Specifies the string to use as a separator
for recursive lookups. This is specified as part of the URL as a query for recursive key lookups. This option is only used when paired with the `keys`
parameter. 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 ### Sample Request

6
website/source/docs/commands/kv/get.html.markdown.erb
View File

@ -38,9 +38,9 @@ Usage: `consul kv get [options] [KEY_OR_PREFIX]`
* `-recurse` - Recursively look at all keys prefixed with the given path. The * `-recurse` - Recursively look at all keys prefixed with the given path. The
default value is false. default value is false.
* `-separator=<string>` - String to use as a separator between keys. The default * `-separator=<string>` - String to use as a separator for recursive lookups. The
value is "/", but this option is only taken into account when paired with the default value is "/", and only used when paired with the `-keys` flag. This will
-keys flag. limit the depth of keys returned, only up to the given separator.
## Examples ## Examples