View Source Tentacat.Repositories.DeployKeys (Tentacat v2.5.0)
The Repository deploy keys API allows repository admins to manage the deploy keys for a repository.
Summary
Functions
Create a deploy key for a repository.
Get a deploy key for a repository by id.
Get a list of deploy keys for a repository.
Remove a deploy key from a repository.
Functions
@spec create(Tentacat.Client.t(), binary(), binary(), map()) :: Tentacat.response()
Create a deploy key for a repository.
Example
Tentacat.Repositories.DeployKeys.create(client, "elixir-lang", "elixir", key_body)
The key_body should be a map corresponding to a json body accepted by the api.
More info at: https://developer.github.com/v3/repos/keys/#add-a-new-deploy-key
@spec find(Tentacat.Client.t(), binary(), binary(), binary() | integer()) :: Tentacat.response()
Get a deploy key for a repository by id.
Example
Tentacat.Repositories.DeployKeys.find(client, "elixir-lang", "elixir", "1234567")
More info at: https://developer.github.com/v3/repos/keys/#get-a-deploy-key
@spec list(Tentacat.Client.t(), binary(), binary()) :: Tentacat.response()
Get a list of deploy keys for a repository.
Example
Tentacat.Repositories.DeployKeys.list(client, "elixir-lang", "elixir")
More info at: https://developer.github.com/v3/repos/keys/#list-deploy-keys
@spec remove(Tentacat.Client.t(), binary(), binary(), binary() | integer()) :: Tentacat.response()
Remove a deploy key from a repository.
Example
Tentacat.Repositories.DeployKeys.remove(client, "elixir-lang", "elixir", "1234567")
More info at: https://developer.github.com/v3/repos/keys/#remove-a-deploy-key