ExVault v0.1.0-beta.1 ExVault View Source
TODO: Proper documentation for ExVault.
Link to this section Summary
Types
Options:
:address
- Address of the Vault server to talk to. (Required):token
- The Vault token to authenticate with. If not provided, any calls requiring authentication will fail.:adapter
- The Tesla adapter to use. Defaults toTesla.Adapter.Hackney
, which has the best out-of-the-box TLS support. Don't change this without a specific reason
Functions
Perform a 'delete' operation
Perform a 'list' operation
Perform a 'read' operation
Perform a 'write' operation
Link to this section Types
Link to this type
body()
View Source
body()
View Source
body() :: Tesla.Env.body()
body() :: Tesla.Env.body()
Link to this type
client()
View Source
client()
View Source
client() :: Tesla.Client.t()
client() :: Tesla.Client.t()
Link to this type
option()
View Source
option()
View Source
option() ::
{:address, String.t()}
| {:token, String.t()}
| {:adapter, Tesla.Client.adapter()}
option() :: {:address, String.t()} | {:token, String.t()} | {:adapter, Tesla.Client.adapter()}
Options:
:address
- Address of the Vault server to talk to. (Required):token
- The Vault token to authenticate with. If not provided, any calls requiring authentication will fail.:adapter
- The Tesla adapter to use. Defaults toTesla.Adapter.Hackney
, which has the best out-of-the-box TLS support. Don't change this without a specific reason.
Link to this type
response()
View Source
response()
View Source
response() :: ExVault.Response.t()
response() :: ExVault.Response.t()
Link to this section Functions
Link to this function
delete(client, path)
View Source
delete(client, path)
View Source
delete(client(), String.t()) :: ExVault.Response.t()
delete(client(), String.t()) :: ExVault.Response.t()
Perform a 'delete' operation.
Params:
client
must be anExVault.client/0
value, as constructed byExVault.new/1
.path
is the full path of the entity to delete.
Link to this function
list(client, path)
View Source
list(client, path)
View Source
list(client(), String.t()) :: ExVault.Response.t()
list(client(), String.t()) :: ExVault.Response.t()
Perform a 'list' operation.
Params:
client
must be anExVault.client/0
value, as constructed byExVault.new/1
.path
is the full path of the entity to list.
Link to this function
new(opts) View Source
Create a new ExVault
client.
Link to this function
read(client, path, opts \\ [])
View Source
read(client, path, opts \\ [])
View Source
read(client(), String.t(), keyword()) :: ExVault.Response.t()
read(client(), String.t(), keyword()) :: ExVault.Response.t()
Perform a 'read' operation.
Params:
client
must be anExVault.client/0
value, as constructed byExVault.new/1
.path
is the full path of the entity to read.opts
is currently unused. FIXME
Link to this function
write(client, path, params)
View Source
write(client, path, params)
View Source
write(client(), String.t(), body()) :: ExVault.Response.t()
write(client(), String.t(), body()) :: ExVault.Response.t()
Perform a 'write' operation.
Params:
client
must be anExVault.client/0
value, as constructed byExVault.new/1
.path
is the full path of the entity to write.params
should be the data to be written, usually in the form of an Elixir map.