class Github::Repos::Keys
def create(*args)
"key" => "ssh-rsa AAA..."
"title" => "octocat@octomac",
github.repos.keys.create 'user-name', 'repo-name',
github = Github.new
= Examples
* :key - Required string.
* :title - Required string.
= Inputs
Create a key
def create(*args) arguments(args, :required => [:user, :repo]) do sift VALID_KEY_OPTIONS assert_required VALID_KEY_OPTIONS end post_request("/repos/#{user}/#{repo}/keys", arguments.params) end
def delete(*args)
github.repos.keys.delete 'user-name', 'repo-name', 'key-id'
github = Github.new
= Examples
Delete key
def delete(*args) arguments(args, :required => [:user, :repo, :key_id]) params = arguments.params delete_request("/repos/#{user}/#{repo}/keys/#{key_id}", params) end
def edit(*args)
"key" => "ssh-rsa AAA..."
"title" => "octocat@octomac",
github.repos.keys.edit 'user-name', 'repo-name',
github = Github.new
= Examples
* :key - Required string.
* :title - Required string.
= Inputs
Edit a key
def edit(*args) arguments(args, :required => [:user, :repo, :key_id]) do sift VALID_KEY_OPTIONS end params = arguments.params patch_request("/repos/#{user}/#{repo}/keys/#{key_id}", params) end
def get(*args)
github.repos.keys.get 'user-name', 'repo-name', 'key-id'
github = Github.new
= Examples
Get a key
def get(*args) arguments(args, :required => [:user, :repo, :key_id]) get_request("/repos/#{user}/#{repo}/keys/#{key_id}", arguments.params) end
def list(*args)
keys.list
keys = Github::Repos::Keys.new user: 'user-name', repo: 'repo-name'
github.repos.keys.list 'user-name', 'repo-name' { |key| ... }
github.repos.keys.list 'user-name', 'repo-name'
github = Github.new
= Examples
List deploy keys
def list(*args) arguments(args, :required => [:user, :repo]) response = get_request("/repos/#{user}/#{repo}/keys", arguments.params) return response unless block_given? response.each { |el| yield el } end