Improve Add/Remove Issue Labels API

changelogs/unreleased/improve_issue_labels_api.yml

+---
+title: Improve Add/Remove Issue Labels API
+merge_request: 31864
+author: Lee Tickett
+type: added

doc/api/issues.md

@@ -768,6 +768,8 @@ PUT /projects/:id/issues/:issue_iid
 | `assignee_ids` | integer array | no | The ID of the user(s) to assign the issue to. Set to `0` or provide an empty value to unassign all assignees. |
 | `milestone_id` | integer | no       | The global ID of a milestone to assign the issue to. Set to `0` or provide an empty value to unassign a milestone.|
 | `labels`       | string  | no       | Comma-separated label names for an issue. Set to an empty string to unassign all labels.                   |
+| `add_labels`   | string  | no       | Comma-separated label names to add to an issue.                                                            |
+| `remove_labels`| string  | no       | Comma-separated label names to remove from an issue.                                                       |
 | `state_event`  | string  | no       | The state event of an issue. Set `close` to close the issue and `reopen` to reopen it                      |
 | `updated_at`   | string  | no       | Date time string, ISO 8601 formatted, for example `2016-03-11T03:45:40Z` (requires admin or project owner rights). Empty string or null values are not accepted.|
 | `due_date`     | string  | no       | Date time string in the format YEAR-MONTH-DAY, for example `2016-03-11`                                           |

lib/api/helpers/issues_helpers.rb

@@ -24,6 +24,8 @@ module API
           :discussion_locked,
           :due_date,
           :labels,
+          :add_labels,
+          :remove_labels,
           :milestone_id,
           :state_event,
           :title

lib/api/issues.rb

@@ -67,6 +67,8 @@ module API
         optional :assignee_id,  type: Integer, desc: '[Deprecated] The ID of a user to assign issue'
         optional :milestone_id, type: Integer, desc: 'The ID of a milestone to assign issue'
         optional :labels, type: Array[String], coerce_with: Validations::Types::LabelsList.coerce, desc: 'Comma-separated list of label names'
+        optional :add_labels, type: Array[String], coerce_with: Validations::Types::LabelsList.coerce, desc: 'Comma-separated list of label names'
+        optional :remove_labels, type: Array[String], coerce_with: Validations::Types::LabelsList.coerce, desc: 'Comma-separated list of label names'
         optional :due_date, type: String, desc: 'Date string in the format YEAR-MONTH-DAY'
         optional :confidential, type: Boolean, desc: 'Boolean parameter if the issue should be confidential'
         optional :discussion_locked, type: Boolean, desc: " Boolean parameter indicating if the issue's discussion is locked"

spec/requests/api/issues/put_projects_issues_spec.rb

@@ -301,6 +301,35 @@ describe API::Issues do
     let!(:label) { create(:label, title: 'dummy', project: project) }
     let!(:label_link) { create(:label_link, label: label, target: issue) }
 
+    it 'adds relevant labels' do
+      put api("/projects/#{project.id}/issues/#{issue.iid}", user),
+        params: { add_labels: '1, 2' }
+
+      expect(response).to have_gitlab_http_status(:ok)
+      expect(json_response['labels']).to contain_exactly(label.title, '1', '2')
+    end
+
+    context 'removes' do
+      let!(:label2) { create(:label, title: 'a-label', project: project) }
+      let!(:label_link2) { create(:label_link, label: label2, target: issue) }
+
+      it 'removes relevant labels' do
+        put api("/projects/#{project.id}/issues/#{issue.iid}", user),
+          params: { remove_labels: label2.title }
+
+        expect(response).to have_gitlab_http_status(:ok)
+        expect(json_response['labels']).to eq([label.title])
+      end
+
+      it 'removes all labels' do
+        put api("/projects/#{project.id}/issues/#{issue.iid}", user),
+          params: { remove_labels: "#{label.title}, #{label2.title}" }
+
+        expect(response).to have_gitlab_http_status(:ok)
+        expect(json_response['labels']).to be_empty
+      end
+    end
+
     it 'does not update labels if not present' do
       put api("/projects/#{project.id}/issues/#{issue.iid}", user),
         params: { title: 'updated title' }