summaryrefslogtreecommitdiff
path: root/doc/api/merge_requests.md
diff options
context:
space:
mode:
Diffstat (limited to 'doc/api/merge_requests.md')
-rw-r--r--doc/api/merge_requests.md23
1 files changed, 23 insertions, 0 deletions
diff --git a/doc/api/merge_requests.md b/doc/api/merge_requests.md
index c4cb7753fc9..57754f62d5a 100644
--- a/doc/api/merge_requests.md
+++ b/doc/api/merge_requests.md
@@ -16,6 +16,7 @@ type: reference, api
> - `with_merge_status_recheck` was [introduced](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/31890) in GitLab 13.0.
> - `reviewer_username` and `reviewer_id` were [introduced](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/49341) in GitLab 13.8.
> - `reviewer_ids` was [introduced](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/51186) in GitLab 13.8.
+> - `draft` was [introduced](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/63473) as an eventual replacement for `work_in_progress` in GitLab 14.0
Every API call to merge requests must be authenticated.
@@ -174,6 +175,7 @@ Parameters:
"Community contribution",
"Manage"
],
+ "draft": false,
"work_in_progress": false,
"milestone": {
"id": 5,
@@ -357,6 +359,7 @@ Parameters:
"Community contribution",
"Manage"
],
+ "draft": false,
"work_in_progress": false,
"milestone": {
"id": 5,
@@ -405,6 +408,16 @@ Parameters:
]
```
+The `merge_status` field may hold one of the following values:
+
+| Value | Interpretation |
+|----------------------------|-----------------------------------------------------------------------|
+| `unchecked` | We have not checked this yet |
+| `checking` | We are currently checking if the merge request can be merged |
+| `can_be_merged` | This merge request can be merged without conflict |
+| `cannot_be_merged` | There are merge conflicts between the source and target branches |
+| `cannot_be_merged_recheck` | Currently unchecked. Before the current changes, there were conflicts |
+
Users on GitLab Premium or higher also see
the `approvals_before_merge` parameter:
@@ -532,6 +545,7 @@ Parameters:
"Community contribution",
"Manage"
],
+ "draft": false,
"work_in_progress": false,
"milestone": {
"id": 5,
@@ -670,6 +684,7 @@ Parameters:
"Community contribution",
"Manage"
],
+ "draft": false,
"work_in_progress": false,
"milestone": {
"id": 5,
@@ -902,6 +917,7 @@ Parameters:
"target_project_id": 4,
"labels": [ ],
"description": "Qui voluptatibus placeat ipsa alias quasi. Deleniti rem ut sint. Optio velit qui distinctio.",
+ "draft": false,
"work_in_progress": false,
"milestone": {
"id": 5,
@@ -1112,6 +1128,7 @@ POST /projects/:id/merge_requests
"Community contribution",
"Manage"
],
+ "draft": false,
"work_in_progress": false,
"milestone": {
"id": 5,
@@ -1282,6 +1299,7 @@ Must include at least one non-required attribute from above.
"Community contribution",
"Manage"
],
+ "draft": false,
"work_in_progress": false,
"milestone": {
"id": 5,
@@ -1467,6 +1485,7 @@ Parameters:
"Community contribution",
"Manage"
],
+ "draft": false,
"work_in_progress": false,
"milestone": {
"id": 5,
@@ -1655,6 +1674,7 @@ Parameters:
"Community contribution",
"Manage"
],
+ "draft": false,
"work_in_progress": false,
"milestone": {
"id": 5,
@@ -1956,6 +1976,7 @@ Example response:
"Community contribution",
"Manage"
],
+ "draft": false,
"work_in_progress": false,
"milestone": {
"id": 5,
@@ -2115,6 +2136,7 @@ Example response:
"Community contribution",
"Manage"
],
+ "draft": false,
"work_in_progress": false,
"milestone": {
"id": 5,
@@ -2291,6 +2313,7 @@ Example response:
"source_project_id": 3,
"target_project_id": 3,
"labels": [],
+ "draft": false,
"work_in_progress": false,
"milestone": {
"id": 27,