| Module | Gitlab::Client::MergeRequests |
| In: |
lib/gitlab/client/merge_requests.rb
|
Defines methods related to merge requests. @see github.com/gitlabhq/gitlabhq/blob/master/doc/api/merge_requests.md
Accepts a merge request.
@example
Gitlab.accept_merge_request(5, 42, { merge_commit_message: 'Nice!' })
@param [Integer] project The ID of a project. @param [Integer] id The ID of a merge request. @param [Hash] options A customizable set of options. @option options [String] :merge_commit_message Custom merge commit message @return [Gitlab::ObjectifiedHash] Information about updated merge request.
Creates a merge request.
@example
Gitlab.create_merge_request(5, 'New merge request',
{ source_branch: 'source_branch', target_branch: 'target_branch' })
Gitlab.create_merge_request(5, 'New merge request',
{ source_branch: 'source_branch', target_branch: 'target_branch', assignee_id: 42 })
@param [Integer] project The ID of a project. @param [String] title The title of a merge request. @param [Hash] options A customizable set of options. @option options [String] :source_branch (required) The source branch name. @option options [String] :target_branch (required) The target branch name. @option options [Integer] :assignee_id (optional) The ID of a user to assign merge request. @option options [Integer] :target_project_id (optional) The target project ID. @return [Gitlab::ObjectifiedHash] Information about created merge request.
Adds a comment to a merge request.
@example
Gitlab.create_merge_request_comment(5, 1, "Awesome merge!")
Gitlab.create_merge_request_comment('gitlab', 1, "Awesome merge!")
@param [Integer] project The ID of a project. @param [Integer] id The ID of a merge request. @param [String] note The content of a comment. @return [Gitlab::ObjectifiedHash] Information about created merge request comment.
Deletes a comment from a merge request.
@example
Gitlab.delete_merge_request_comment(5, 1,2)
Gitlab.delete_merge_request_comment('gitlab', 1, 2)
@param [Integer] project The ID of a project. @param [Integer] id The ID of a merge request. @param [Integer] id The ID of the merge-request comment @return [Gitlab::ObjectifiedHash] Information about created merge request comment.
Adds a comment to a merge request.
@example
Gitlab.edit_merge_request_comment(5, 1,2, "Awesome merge!")
Gitlab.edit_merge_request_comment('gitlab', 1, 2, "Awesome merge!")
@param [Integer] project The ID of a project. @param [Integer] id The ID of a merge request. @param [Integer] id The ID of the merge-request comment @param [String] note The content of a comment. @return [Gitlab::ObjectifiedHash] Information about created merge request comment.
Gets a single merge request.
@example
Gitlab.merge_request(5, 36)
@param [Integer] project The ID of a project. @param [Integer] id The ID of a merge request. @return <Gitlab::ObjectifiedHash]
Gets the changes of a merge request.
@example
Gitlab.merge_request_changes(5, 1)
@param [Integer] project The ID of a project. @param [Integer] id The ID of a merge request. @return [Gitlab::ObjectifiedHash] The merge request‘s changes.
Gets the comments on a merge request.
@example
Gitlab.merge_request_comments(5, 1)
Gitlab.merge_request_comments(5, 1, { per_page: 10, page: 2 })
@param [Integer] project The ID of a project. @param [Integer] id The ID of a merge request. @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 [Gitlab::ObjectifiedHash] The merge request‘s comments.
Gets the commits of a merge request.
@example
Gitlab.merge_request_commits(5, 1)
@param [Integer] project The ID of a project. @param [Integer] id The ID of a merge request. @return [Array<Gitlab::ObjectifiedHash>] The merge request‘s commits.
Gets a list of project merge requests.
@example
Gitlab.merge_requests(5)
Gitlab.merge_requests({ per_page: 40 })
@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>]
Updates a merge request.
@example
Gitlab.update_merge_request(5, 42, { title: 'New title' })
@param [Integer] project The ID of a project. @param [Integer] id The ID of a merge request. @param [Hash] options A customizable set of options. @option options [String] :title The title of a merge request. @option options [String] :source_branch The source branch name. @option options [String] :target_branch The target branch name. @option options [Integer] :assignee_id The ID of a user to assign merge request. @option options [String] :state_event New state (close|reopen|merge). @return [Gitlab::ObjectifiedHash] Information about updated merge request.