Wordsmith the docs around the list command.

Prompted by: feedback from conference attendees at PGConf '16
This commit is contained in:
Sean Chittenden 2016-04-20 18:13:58 -04:00
parent e68de75e83
commit f6bec6e017
2 changed files with 7 additions and 7 deletions

View file

@ -65,9 +65,9 @@ over operations. The capabilities are:
* `delete` - Delete the value at a path.
* `list` - List values at a path. Note that the keys returned by a `list`
operation are *not* filtered by policies. You should not store
sensitive/secret values in keys.
* `list` - List key names at a path. Note that the keys returned by a
`list` operation are *not* filtered by policies. Do not encode sensitive
information in key names.
* `sudo` - Gain access to paths that are _root-protected_. This is _additive_
to other capabilities, so a path that requires `sudo` access will also

View file

@ -107,11 +107,11 @@ seconds (one hour) as specified.
<dl class="api">
<dt>Description</dt>
<dd>
Returns a list of secret entries at the specified location. Folders are
Returns a list of key names at the specified location. Folders are
suffixed with `/`. The input must be a folder; list on a file will not
return a value. Note that no policy-based filtering is performed on
returned keys; it is not recommended to put sensitive or secret values as
key names. The values themselves are not accessible via this command.
return a value. Note that no policy-based filtering is performed on keys;
do not encode sensitive information in key names. The values themselves
are not accessible via this command.
</dd>
<dt>Method</dt>