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

Link to this function

create(client, owner, repo, body)

View Source
@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

Link to this function

find(client, owner, repo, key_id)

View Source

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

Link to this function

list(client, owner, repo)

View Source

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

Link to this function

remove(client, owner, repo, key_id)

View Source
@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