class Github::Client::Repos::Contents

as Base64 encoded content.
These API methods let you retrieve the contents of files within a repository

def archive(*args)

Other tags:
    Api: - public

Parameters:
  • params (Hash) --

Other tags:
    Note: -
def archive(*args)
  arguments(args, required: [:user, :repo])
  params         = arguments.params
  archive_format = params.delete('archive_format') || 'tarball'
  ref            = params.delete('ref') || 'master'
  get_request("/repos/#{arguments.user}/#{arguments.repo}/#{archive_format}/#{ref}", params)
end

def create(*args)

Other tags:
    Api: - public

Options Hash: (**params)
  • :email (String) --
  • :name (String) --
  • :branch (String) --
  • :content (String) --
  • :message (String) --
  • (String) --
  • :path (String) --

Parameters:
  • params (Hash) --
def create(*args)
  arguments(args, required: [:user, :repo, :path]) do
    assert_required REQUIRED_CONTENT_OPTIONS
  end
  params = arguments.params
  params.strict_encode64('content')
  put_request("/repos/#{arguments.user}/#{arguments.repo}/contents/#{arguments.path}", params)
end

def delete(*args)

Options Hash: (**params)
  • :email (String) --
  • :name (String) --
  • :branch (String) --
  • :sha (String) --
  • :message (String) --
  • (String) --
  • :path (String) --

Parameters:
  • params (Hash) --
def delete(*args)
  arguments(args, required: [:user, :repo, :path]) do
    assert_required %w[ path message sha ]
  end
  delete_request("/repos/#{arguments.user}/#{arguments.repo}/contents/#{arguments.path}", arguments.params)
end

def get(*args)

Other tags:
    Api: - public

Options Hash: (**params)
  • :ref (String) --
  • :path (String) --

Parameters:
  • params (Hash) --
def get(*args)
  arguments(args, required: [:user, :repo, :path])
  get_request("/repos/#{arguments.user}/#{arguments.repo}/contents/#{arguments.path}", arguments.params)
end

def readme(*args)

Other tags:
    Api: - public

Options Hash: (**params)
  • :ref (String) --

Parameters:
  • params (Hash) --
def readme(*args)
  arguments(args, required: [:user, :repo])
  get_request("/repos/#{arguments.user}/#{arguments.repo}/readme", arguments.params)
end

def update(*args)

Other tags:
    Api: - public

Options Hash: (**params)
  • :email (String) --
  • :name (String) --
  • :branch (String) --
  • :sha (String) --
  • :content (String) --
  • :message (String) --
  • (String) --
  • :path (String) --

Parameters:
  • params (Hash) --
def update(*args)
  create(*args)
end