libvault v0.2.4

View Source Vault.Engine.Adapter behaviour (libvault v0.2.4)

Adapter specificication for Vault Secret Engines

Link to this section Summary

Types

data()
errors()
options()
path()
response()
token()
value()
vault()

Callbacks

delete(vault, path, options)
list(vault, path, options)
read(vault, path, options)
write(vault, path, value, options)

Link to this section Types

Link to this type

data()

View Source 
@type data() :: term()
Link to this type

errors()

View Source 
@type errors() :: list()
Link to this type

options()

View Source 
@type options() :: list()
Link to this type

path()

View Source 
@type path() :: String.t()
Link to this type

response()

View Source 
@type response() :: {:ok, data()} | {:error, errors()}
Link to this type

token()

View Source 
@type token() :: String.t()
Link to this type

value()

View Source 
@type value() :: term()
Link to this type

vault()

View Source 
@type vault() :: Vault.t()

Link to this section Callbacks

Link to this callback

delete(vault, path, options)

View Source 
@callback delete(vault(), path(), options()) :: response()
Link to this callback

list(vault, path, options)

View Source 
@callback list(vault(), path(), options()) :: response()
Link to this callback

read(vault, path, options)

View Source 
@callback read(vault(), path(), options()) :: response()
Link to this callback

write(vault, path, value, options)

View Source 
@callback write(vault(), path(), value(), options()) :: response()