ExDoppler.Configs (ExDoppler v1.0.1)
View SourceModule for interacting with ExDoppler.Config
๐ Resources
- ๐ Doppler docs
- ๐ Doppler API docs
- ๐ฌ Contact the maintainer (he's happy to help!)
Summary
Functions
Clones a ExDoppler.Config
to a new Config
Same as clone_config/3
but won't wrap a successful response in {:ok, response}
Same as create_config/3
but won't wrap a successful response in {:ok, response}
Same as delete_config/2
but won't wrap a successful response in {:ok, response}
Same as get_config/2
but won't wrap a successful response in {:ok, response}
Lists ExDoppler.Config
using pagination.
Same as list_configs/2
but won't wrap a successful response in {:ok, response}
Locks a ExDoppler.Config
(no modifications allowed)
Same as lock_config/2
but won't wrap a successful response in {:ok, response}
Same as rename_config/3
but won't wrap a successful response in {:ok, response}
Same as set_config_inheritable/3
but won't wrap a successful response in {:ok, response}
Unlocks a ExDoppler.Config
(modifications allowed)
Same as unlock_config/2
but won't wrap a successful response in {:ok, response}
Functions
Clones a ExDoppler.Config
to a new Config
๐ท๏ธ Params
- project_name: The relevant project name (e.g
"example-project"
) - source_config: The config to clone (e.g
"prd_aws"
) - new_config_name: The config name to clone (e.g
"prd_aws2"
)
โคต๏ธ Returns
โ On Success
{:ok, %ExDoppler.Config{...}}
โ On Failure
{:error, err}
๐ป Examples
iex> alias ExDoppler.Configs
iex> _ = Configs.delete_config!("example-project", "dev_doc")
iex> _ = Configs.delete_config!("example-project", "dev_doc2")
iex> {:ok, _config} = Configs.create_config("example-project", "dev", "dev_doc")
iex> {:ok, _config} = Configs.clone_config("example-project", "dev_doc", "dev_doc2")
iex> :ok = Configs.delete_config!("example-project", "dev_doc")
iex> :ok = Configs.delete_config!("example-project", "dev_doc2")
๐ Resources
- ๐ Doppler API docs
- ๐ฌ Contact the maintainer (he's happy to help!)
Same as clone_config/3
but won't wrap a successful response in {:ok, response}
Creates a new ExDoppler.Config
๐ท๏ธ Params
- project_name: The relevant project name (e.g
"example-project"
) - environment_id: The relevant environment id (e.g
"prd"
) - config_name: The config name to make (e.g
"prd_aws"
)
โคต๏ธ Returns
โ On Success
{:ok, %ExDoppler.Config{...}}
โ On Failure
{:error, err}
๐ป Examples
iex> alias ExDoppler.Configs
iex> _ = Configs.delete_config!("example-project", "dev_doc")
iex> {:ok, _config} = Configs.create_config("example-project", "dev", "dev_doc")
iex> {:ok, _config} = Configs.get_config("example-project", "dev_doc")
iex> {:ok, _} = Configs.delete_config("example-project", "dev_doc")
๐ Resources
- ๐ Doppler API docs
- ๐ฌ Contact the maintainer (he's happy to help!)
Same as create_config/3
but won't wrap a successful response in {:ok, response}
Deletes a ExDoppler.Config
๐ท๏ธ Params
- project_name: The relevant project name (e.g
"example-project"
) - config_name: The config to delete (e.g
"prd_aws"
)
โคต๏ธ Returns
โ On Success
{:ok, {:success, true}}
โ On Failure
{:error, err}
๐ป Examples
iex> alias ExDoppler.Configs
iex> alias ExDoppler.Config
iex> _ = Configs.delete_config!("example-project", "dev_doc")
iex> {:ok, _config} = Configs.create_config("example-project", "dev", "dev_doc")
iex> {:ok, {:success, true}} = Configs.delete_config("example-project", "dev_doc")
๐ Resources
- ๐ Doppler API docs
- ๐ฌ Contact the maintainer (he's happy to help!)
Same as delete_config/2
but won't wrap a successful response in {:ok, response}
Retrieves a ExDoppler.Config
๐ท๏ธ Params
- project_name: The relevant project name (e.g
"example-project"
) - config_name: The config name to get (e.g
"dev_personal"
)
โคต๏ธ Returns
โ On Success
{:ok, %ExDoppler.Config{...}}
โ On Failure
{:error, err}
๐ป Examples
iex> alias ExDoppler.Configs
iex> {:ok, _config} = Configs.get_config("example-project", "dev")
๐ Resources
- ๐ Doppler API docs
- ๐ฌ Contact the maintainer (he's happy to help!)
Same as get_config/2
but won't wrap a successful response in {:ok, response}
Lists ExDoppler.Config
using pagination.
๐ท๏ธ Params
- project: The
ExDoppler.Project
for which you want the configs (e.g%Project{name: "example-project"}
) - 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.Config
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.Config{...}]}
โ On Failure
{:error, err}
๐ป Examples
iex> alias ExDoppler.Configs
iex> alias ExDoppler.Projects
iex> [project | _] = Projects.list_projects!()
iex> {:ok, _configs} = Configs.list_configs(project, page: 1, per_page: 20)
๐ Resources
- ๐ Doppler API docs
- ๐ฌ Contact the maintainer (he's happy to help!)
Same as list_configs/2
but won't wrap a successful response in {:ok, response}
Locks a ExDoppler.Config
(no modifications allowed)
๐ท๏ธ Params
- project_name: The relevant project name (e.g
"example-project"
) - config_name: The config to lock (e.g
"prd_aws"
)
โคต๏ธ Returns
โ On Success
{:ok, %ExDoppler.Config{...}}
โ On Failure
{:error, err}
๐ป Examples
iex> alias ExDoppler.Configs
iex> alias ExDoppler.Config
iex> _ = Configs.delete_config!("example-project", "dev_doc")
iex> {:ok, _config} = Configs.create_config("example-project", "dev", "dev_doc")
iex> {:ok, %Config{locked: true}} = Configs.lock_config("example-project", "dev_doc")
iex> {:ok, %Config{locked: false}} = Configs.unlock_config("example-project", "dev_doc")
iex> :ok = Configs.delete_config!("example-project", "dev_doc")
๐ Resources
- ๐ Doppler API docs
- ๐ฌ Contact the maintainer (he's happy to help!)
Same as lock_config/2
but won't wrap a successful response in {:ok, response}
Renames a ExDoppler.Config
๐ท๏ธ Params
- project_name: The relevant project name (e.g
"example-project"
) - current_config_name: The relevant environment id (e.g
"prd_aws"
) - new_config_name: The new config name (e.g
"prd_gcp"
)
โคต๏ธ Returns
โ On Success
{:ok, %ExDoppler.Config{...}}
โ On Failure
{:error, err}
๐ป Examples
iex> alias ExDoppler.Configs
iex> _ = Configs.delete_config!("example-project", "dev_doc")
iex> _ = Configs.delete_config!("example-project", "dev_doc2")
iex> {:ok, _config} = Configs.create_config("example-project", "dev", "dev_doc")
iex> {:ok, _config} = Configs.rename_config("example-project", "dev_doc", "dev_doc2")
iex> {:ok, _} = Configs.delete_config("example-project", "dev_doc2")
๐ Resources
- ๐ Doppler API docs
- ๐ฌ Contact the maintainer (he's happy to help!)
Same as rename_config/3
but won't wrap a successful response in {:ok, response}
Same as set_config_inheritable/3
but won't wrap a successful response in {:ok, response}
Unlocks a ExDoppler.Config
(modifications allowed)
๐ท๏ธ Params
- project_name: The relevant project name (e.g
"example-project"
) - config_name: The config to unlock (e.g
"prd_aws"
)
โคต๏ธ Returns
โ On Success
{:ok, %ExDoppler.Config{...}}
โ On Failure
{:error, err}
๐ป Examples
iex> alias ExDoppler.Configs
iex> alias ExDoppler.Config
iex> _ = Configs.delete_config!("example-project", "dev_doc")
iex> {:ok, _config} = Configs.create_config("example-project", "dev", "dev_doc")
iex> {:ok, %Config{locked: true}} = Configs.lock_config("example-project", "dev_doc")
iex> {:ok, %Config{locked: false}} = Configs.unlock_config("example-project", "dev_doc")
iex> :ok = Configs.delete_config!("example-project", "dev_doc")
๐ Resources
- ๐ Doppler API docs
- ๐ฌ Contact the maintainer (he's happy to help!)
Same as unlock_config/2
but won't wrap a successful response in {:ok, response}