summaryrefslogtreecommitdiff
path: root/lib/api/entities.rb
diff options
context:
space:
mode:
authorOswaldo Ferreira <oswaldo@gitlab.com>2018-01-23 19:08:10 -0200
committerOswaldo Ferreira <oswaldo@gitlab.com>2018-01-23 19:08:24 -0200
commitdc84313e73da8454cd043dbd235a2b552658d8ae (patch)
tree374c8dcff81fea618b45948b5092c56f914903ca /lib/api/entities.rb
parentc4904d570c2c5094d2d2bfee5d243b39556fdc89 (diff)
downloadgitlab-ce-dc84313e73da8454cd043dbd235a2b552658d8ae.tar.gz
Return more consistent values for merge_status on MR API
Diffstat (limited to 'lib/api/entities.rb')
-rw-r--r--lib/api/entities.rb11
1 files changed, 10 insertions, 1 deletions
diff --git a/lib/api/entities.rb b/lib/api/entities.rb
index 3f4b62dc1b2..6af379451a6 100644
--- a/lib/api/entities.rb
+++ b/lib/api/entities.rb
@@ -507,7 +507,16 @@ module API
expose :work_in_progress?, as: :work_in_progress
expose :milestone, using: Entities::Milestone
expose :merge_when_pipeline_succeeds
- expose :merge_status
+
+ # Ideally we should deprecate `MergeRequest#merge_status` exposure and
+ # use `MergeRequest#mergeable?` instead (boolean).
+ # See https://gitlab.com/gitlab-org/gitlab-ce/issues/42344 for more
+ # information.
+ expose :merge_status do |merge_request|
+ # In order to avoid having a breaking change for users, we keep returning the
+ # expected values from MergeRequest#merge_status state machine.
+ merge_request.mergeable? ? 'can_be_merged' : 'cannot_be_merged'
+ end
expose :diff_head_sha, as: :sha
expose :merge_commit_sha
expose :user_notes_count