diff options
| author | Dave Henderson <dhenderson@gmail.com> | 2018-05-21 22:12:10 -0400 |
|---|---|---|
| committer | Dave Henderson <dhenderson@gmail.com> | 2018-05-21 23:13:31 -0400 |
| commit | 9a25f47a14d897053424eecd239daeed54da69d1 (patch) | |
| tree | 51b000a78e13c565fb12354f5307063bfccdff4f /docs | |
| parent | 52a382ce95402776219434f6e46dd980ef1471af (diff) | |
Adding directory support for file datasources
Signed-off-by: Dave Henderson <dhenderson@gmail.com>
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/content/datasources.md | 10 |
1 files changed, 5 insertions, 5 deletions
diff --git a/docs/content/datasources.md b/docs/content/datasources.md index c58a700e..e80744ee 100644 --- a/docs/content/datasources.md +++ b/docs/content/datasources.md @@ -53,6 +53,7 @@ When the _path_ component of the URL ends with a `/` character, the datasource i Currently the following datasources support directory semantics: +- [File](#using-file-datasources) - [Vault](#using-vault-datasources) - translates to Vault's [LIST](https://www.vaultproject.io/api/index.html#reading-writing-and-listing-secrets) method When accessing a directory datasource, an array of key names is returned, and can be iterated through to access each individual value contained within. @@ -227,15 +228,14 @@ value for foo/bar/baz key ## Using `file` datasources -The `file` datasource type provides access to files in any of the [supported formats](#mime-types). +The `file` datasource type provides access to files in any of the [supported formats](#mime-types). [Directory datasource](#directory-datasources) semantics are supported. ### URL Considerations -For `file`, the _scheme_ and _path_ are used, and the _query_ component can be used to [override the MIME type](#overriding-mime-types). +The _scheme_ and _path_ are used, and the _query_ component can be used to [override the MIME type](#overriding-mime-types). -Unique to `file`, the _scheme_ can be omitted to allow setting relative paths. - -In addition, if the file being referenced is in the current working directory, the file's base name (without extension) is used as the datasource alias in absence of an explicit alias. +- the _scheme_ must be `file` for absolute URLs, but may be omitted to allow setting relative paths +- the _path_ component is required, and can be an absolute or relative path, and if the file being referenced is in the current working directory, the file's base name (without extension) is used as the datasource alias in absence of an explicit alias. [Directory](#directory-datasources) semantics are available when the path ends with a `/` character. ### Examples |