Aura.Repos (Aura v0.9.1)

View Source

Service module for interacting with Aura.Model.HexRepo

Summary

Functions

Deletes all API keys for the authenticated requester

Deletes an API key for the authenticated requester, given a key_name

Returns a Aura.Model.HexAPIKey associated with a given key_name

Returns a Aura.Model.HexRepo associated with a given repo_name

Returns a list of Aura.Model.HexAPIKey, given the requester's authentication

Returns all visible Aura.Model.HexRepos available

Functions

create_api_key(key_name, username, password, allow_write \\ false, opts \\ [])

@spec create_api_key(
  key_name :: Aura.Common.api_key_name(),
  username :: Aura.Common.username(),
  password :: String.t(),
  allow_write :: boolean(),
  opts :: list()
) :: {:ok, Aura.Model.HexAPIKey.t()} | {:error, any()}

Creates a new Aura.Model.HexAPIKey

delete_all_api_keys(opts \\ [])

@spec delete_all_api_keys(opts :: list()) :: :ok | {:error, any()}

Deletes all API keys for the authenticated requester

delete_api_key(key_name, opts \\ [])

@spec delete_api_key(key_name :: Aura.Common.api_key_name(), opts :: list()) ::
  :ok | {:error, any()}

Deletes an API key for the authenticated requester, given a key_name

get_api_key(key_name, opts \\ [])

@spec get_api_key(key_name :: Aura.Common.api_key_name(), opts :: list()) ::
  {:ok, Aura.Model.HexAPIKey.t()} | {:error, any()}

Returns a Aura.Model.HexAPIKey associated with a given key_name

get_repo(repo_name, opts \\ [])

@spec get_repo(repo_name :: Aura.Common.repo_name(), opts :: list()) ::
  {:ok, Aura.Model.HexRepo.t()} | {:error, any()}

Returns a Aura.Model.HexRepo associated with a given repo_name

list_api_keys(opts \\ [])

@spec list_api_keys(opts :: list()) ::
  {:ok, [Aura.Model.HexAPIKey.t()]} | {:error, any()}

Returns a list of Aura.Model.HexAPIKey, given the requester's authentication

list_repos(opts \\ [])

@spec list_repos(opts :: list()) :: {:ok, [Aura.Model.HexRepo.t()]} | {:error, any()}

Returns all visible Aura.Model.HexRepos available