lib/gitlab/client/repositories.rb in gitlab-2.2.0 vs lib/gitlab/client/repositories.rb in gitlab-3.0.0
- old
+ new
@@ -3,13 +3,12 @@
module Repositories
# Gets a list of project repository tags.
#
# @example
# Gitlab.tags(42)
- # Gitlab.repo_tags('gitlab')
#
- # @param [Integer, String] project The ID or code name of a project.
+ # @param [Integer] project The ID of a project.
# @param [Hash] options A customizable set of options.
# @option options [Integer] :page The page number.
# @option options [Integer] :per_page The number of results per page.
# @return [Array<Gitlab::ObjectifiedHash>]
def tags(project, options={})
@@ -19,13 +18,12 @@
# Gets a list of project repositiory branches.
#
# @example
# Gitlab.branches(42)
- # Gitlab.repo_branches('gitlab')
#
- # @param [Integer, String] project The ID or code name of a project.
+ # @param [Integer] project The ID of a project.
# @param [Hash] options A customizable set of options.
# @option options [Integer] :page The page number.
# @option options [Integer] :per_page The number of results per page.
# @return [Array<Gitlab::ObjectifiedHash>]
def branches(project, options={})
@@ -37,11 +35,11 @@
#
# @example
# Gitlab.branch(3, 'api')
# Gitlab.repo_branch(5, 'master')
#
- # @param [Integer, String] project The ID or code name of a project.
+ # @param [Integer] project The ID of a project.
# @param [String] branch The name of the branch.
# @return [Gitlab::ObjectifiedHash]
def branch(project, branch)
get("/projects/#{project}/repository/branches/#{branch}")
end
@@ -51,10 +49,10 @@
#
# @example
# Gitlab.commits('viking')
# Gitlab.repo_commits('gitlab', :ref_name => 'api')
#
- # @param [String] project The name of a project.
+ # @param [Integer] project The ID of a project.
# @param [Hash] options A customizable set of options.
# @option options [String] :ref_name The branch or tag name of a project repository.
# @option options [Integer] :page The page number.
# @option options [Integer] :per_page The number of results per page.
# @return [Array<Gitlab::ObjectifiedHash>]