ExDoppler.ConfigLogs (ExDoppler v1.0.1)
View SourceModule for interacting with ExDoppler.ConfigLog
๐ Resources
- ๐ Doppler docs
- ๐ Doppler API docs
- ๐ฌ Contact the maintainer (he's happy to help!)
Summary
Functions
Retrieves a ExDoppler.ConfigLog
, given a config and log id
Same as get_config_log/2
but won't wrap a successful response in {:ok, response}
Lists ExDoppler.ConfigLog
using pagination.
Same as list_config_logs/2
but won't wrap a successful response in {:ok, response}
Rolls back a ExDoppler.ConfigLog
Same as rollback_config_log/1
but won't wrap a successful response in {:ok, response}
Functions
Retrieves a ExDoppler.ConfigLog
, given a config and log id
๐ท๏ธ Params
- config: The relevant
ExDoppler.Config
(e.g%Config{project: "example-project", name: "dev"}
) - log_id: Unique identifier for the log object.
โคต๏ธ Returns
โ On Success
{:ok, %ExDoppler.ConfigLog{...}}
โ On Failure
{:error, err}
๐ป Examples
iex> alias ExDoppler.ConfigLogs
iex> alias ExDoppler.Configs
iex> alias ExDoppler.Projects
iex> [project | _] = Projects.list_projects!()
iex> [config | _] = Configs.list_configs!(project)
iex> _config_log = ConfigLogs.get_config_log(config, "Ul8KeqJzKK3n7OadwqX5RZW2")
๐ Resources
- ๐ Doppler API docs
- ๐ฌ Contact the maintainer (he's happy to help!)
Same as get_config_log/2
but won't wrap a successful response in {:ok, response}
Lists ExDoppler.ConfigLog
using pagination.
๐ท๏ธ Params
- config: The
ExDoppler.Config
for which you want the logs (e.g%Config{project: "example-project", name: "dev"}
) - opts: Optional modifications to the list call
- page - which page to list (starts at 1) (e.g
page: 2
). Default:1
- per_page - the number of
ExDoppler.ConfigLog
to return for this page (e.gper_page: 50
). Default:20
- page - which page to list (starts at 1) (e.g
โคต๏ธ Returns
โ On Success
{:ok, [%ExDoppler.ConfigLog{...}]}
โ On Failure
{:error, err}
๐ป Examples
iex> alias ExDoppler.ConfigLogs
iex> alias ExDoppler.Configs
iex> alias ExDoppler.Projects
iex> [project | _] = Projects.list_projects!()
iex> [config | _] = Configs.list_configs!(project)
iex> _config_logs = ConfigLogs.list_config_logs!(config, page: 1, per_page: 20)
๐ Resources
- ๐ Doppler API docs
- ๐ฌ Contact the maintainer (he's happy to help!)
Same as list_config_logs/2
but won't wrap a successful response in {:ok, response}
Rolls back a ExDoppler.ConfigLog
๐ท๏ธ Params
- config_log: The
ExDoppler.ConfigLog
to roll back (e.g%ConfigLog{project: "example-project", config: "dev", id: "0000.."}
)
โคต๏ธ Returns
โ On Success
{:ok, %ExDoppler.ConfigLog{...}}
โ On Failure
{:error, err}
๐ป Examples
iex> alias ExDoppler.ConfigLogs
iex> alias ExDoppler.ConfigLog
iex> _config_log = ConfigLogs.rollback_config_log!(%ConfigLog{project: "example-project", config: "dev", id: "Ul8KeqJzKK3n7OadwqX5RZW2" })
๐ Resources
- ๐ Doppler API docs
- ๐ฌ Contact the maintainer (he's happy to help!)
Same as rollback_config_log/1
but won't wrap a successful response in {:ok, response}