Merge branch 'api-remove-source-branch' into 'master'

API: Ability to remove source branch

Closes https://gitlab.com/gitlab-org/gitlab-ce/issues/23577

See merge request !7804

1 files changed, 26 insertions, 23 deletions

diff --git a/doc/api/merge_requests.md b/doc/api/merge_requests.md
index 9460b3f73b1..81df55ab4ab 100644
--- a/doc/api/merge_requests.md
+++ b/doc/api/merge_requests.md
@@ -271,17 +271,18 @@ Creates a new merge request.
 POST /projects/:id/merge_requests
 ```
 
-Parameters:
-
-- `id` (required)                - The ID of a project
-- `source_branch` (required)     - The source branch
-- `target_branch` (required)     - The target branch
-- `assignee_id` (optional)       - Assignee user ID
-- `title` (required)             - Title of MR
-- `description` (optional)       - Description of MR
-- `target_project_id` (optional) - The target project (numeric id)
-- `labels` (optional)            - Labels for MR as a comma-separated list
-- `milestone_id` (optional)      - Milestone ID
+| Attribute | Type | Required | Description |
+| --------- | ---- | -------- | ----------- |
+| `id`            | string  | yes | The ID of a project |
+| `source_branch` | string  | yes | The source branch |
+| `target_branch` | string  | yes | The target branch |
+| `title`         | string  | yes | Title of MR |
+| `assignee_id`   | integer | no  | Assignee user ID |
+| `description`   | string  | no  | Description of MR |
+| `target_project_id` | integer  | no | The target project (numeric id) |
+| `labels` | string  | no | Labels for MR as a comma-separated list |
+| `milestone_id` | integer  | no | The ID of a milestone |
+| `remove_source_branch` | boolean  | no | Flag indicating if a merge request should remove the source branch when merging |
 
 ```json
 {
@@ -346,17 +347,19 @@ Updates an existing merge request. You can change the target branch, title, or e
 PUT /projects/:id/merge_requests/:merge_request_id
 ```
 
-Parameters:
-
-- `id` (required)               - The ID of a project
-- `merge_request_id` (required) - ID of MR
-- `target_branch`               - The target branch
-- `assignee_id`                 - Assignee user ID
-- `title`                       - Title of MR
-- `description`                 - Description of MR
-- `state_event`                 - New state (close|reopen|merge)
-- `labels` (optional)           - Labels for MR as a comma-separated list
-- `milestone_id` (optional)     - Milestone ID
+| Attribute | Type | Required | Description |
+| --------- | ---- | -------- | ----------- |
+| `id`            | string  | yes | The ID of a project |
+| `merge_request_id` | integer  | yes | The ID of a merge request |
+| `source_branch` | string  | yes | The source branch |
+| `target_branch` | string  | yes | The target branch |
+| `title`         | string  | yes | Title of MR |
+| `assignee_id`   | integer | no  | Assignee user ID |
+| `description`   | string  | no  | Description of MR |
+| `target_project_id` | integer  | no | The target project (numeric id) |
+| `labels` | string  | no | Labels for MR as a comma-separated list |
+| `milestone_id` | integer  | no | The ID of a milestone |
+| `remove_source_branch` | boolean  | no | Flag indicating if a merge request should remove the source branch when merging |
 
 ```json
 {
@@ -807,7 +810,7 @@ Example response:
 
 ## Create a todo
 
-Manually creates a todo for the current user on a merge request. 
+Manually creates a todo for the current user on a merge request.
 If there already exists a todo for the user on that merge request,
 status code `304` is returned.