Skip to content

G
gitlab-ce
Commit 1ddf1942 authored by Rémy Coutable's avatar Rémy Coutable
Browse files
Options

Improve the MR documentation 

Signed-off-by: default avatarRémy Coutable <remy@rymai.me>
parent d7a3ccb4
Hide whitespace changes
Inline Side-by-side
Showing with 473 additions and 209 deletions
doc/api/merge_requests.md
View file @ 1ddf1942
...@@ -54,35 +54,38 @@ Parameters: ...@@ -54,35 +54,38 @@ Parameters:
{ {
"id": 1, "id": 1,
"iid": 1, "iid": 1,
"target_branch": "master",
"source_branch": "test1",
"project_id": 3, "project_id": 3,
"title": "test1", "title": "test1",
"description": "fixed login page css paddings",
"state": "opened", "state": "opened",
"created_at": "2017-04-29T08:46:00Z", "created_at": "2017-04-29T08:46:00Z",
"updated_at": "2017-04-29T08:46:00Z", "updated_at": "2017-04-29T08:46:00Z",
"target_branch": "master",
"source_branch": "test1",
"upvotes": 0, "upvotes": 0,
"downvotes": 0, "downvotes": 0,
"author": { "author": {
"id": 1, "id": 1,
"username": "admin",
"name": "Administrator", "name": "Administrator",
"username": "admin",
"state": "active", "state": "active",
"avatar_url": null, "avatar_url": null,
"web_url" : "https://gitlab.example.com/admin" "web_url" : "https://gitlab.example.com/admin"
}, },
"assignee": { "assignee": {
"id": 1, "id": 1,
"username": "admin",
"name": "Administrator", "name": "Administrator",
"username": "admin",
"state": "active", "state": "active",
"avatar_url": null, "avatar_url": null,
"web_url" : "https://gitlab.example.com/admin" "web_url" : "https://gitlab.example.com/admin"
}, },
"source_project_id": 2, "source_project_id": 2,
"target_project_id": 3, "target_project_id": 3,
"labels": [ ], "labels": [
"description": "fixed login page css paddings", "Community contribution",
"Manage"
],
"work_in_progress": false, "work_in_progress": false,
"milestone": { "milestone": {
"id": 5, "id": 5,
...@@ -93,23 +96,28 @@ Parameters: ...@@ -93,23 +96,28 @@ Parameters:
"state": "closed", "state": "closed",
"created_at": "2015-02-02T19:49:26.013Z", "created_at": "2015-02-02T19:49:26.013Z",
"updated_at": "2015-02-02T19:49:26.013Z", "updated_at": "2015-02-02T19:49:26.013Z",
"due_date": null "due_date": "2018-09-22",
"start_date": "2018-08-08",
"web_url": "https://gitlab.example.com/my-group/my-project/milestones/1"
}, },
"merge_when_pipeline_succeeds": true, "merge_when_pipeline_succeeds": true,
"merge_status": "can_be_merged", "merge_status": "can_be_merged",
"sha": "8888888888888888888888888888888888888888", "sha": "8888888888888888888888888888888888888888",
"merge_commit_sha": null, "merge_commit_sha": null,
"user_notes_count": 1, "user_notes_count": 1,
"discussion_locked": null,
"should_remove_source_branch": true, "should_remove_source_branch": true,
"force_remove_source_branch": false, "force_remove_source_branch": false,
"squash": false, "allow_collaboration": false,
"web_url": "http://example.com/example/example/merge_requests/1", "allow_maintainer_to_push": false,
"web_url": "http://gitlab.example.com/my-group/my-project/merge_requests/1",
"time_stats": { "time_stats": {
"time_estimate": 0, "time_estimate": 0,
"total_time_spent": 0, "total_time_spent": 0,
"human_time_estimate": null, "human_time_estimate": null,
"human_total_time_spent": null "human_total_time_spent": null
} },
"squash": false
} }
] ]
``` ```
...@@ -169,35 +177,38 @@ Parameters: ...@@ -169,35 +177,38 @@ Parameters:
{ {
"id": 1, "id": 1,
"iid": 1, "iid": 1,
"target_branch": "master",
"source_branch": "test1",
"project_id": 3, "project_id": 3,
"title": "test1", "title": "test1",
"description": "fixed login page css paddings",
"state": "opened", "state": "opened",
"created_at": "2017-04-29T08:46:00Z", "created_at": "2017-04-29T08:46:00Z",
"updated_at": "2017-04-29T08:46:00Z", "updated_at": "2017-04-29T08:46:00Z",
"target_branch": "master",
"source_branch": "test1",
"upvotes": 0, "upvotes": 0,
"downvotes": 0, "downvotes": 0,
"author": { "author": {
"id": 1, "id": 1,
"username": "admin",
"name": "Administrator", "name": "Administrator",
"username": "admin",
"state": "active", "state": "active",
"avatar_url": null, "avatar_url": null,
"web_url" : "https://gitlab.example.com/admin" "web_url" : "https://gitlab.example.com/admin"
}, },
"assignee": { "assignee": {
"id": 1, "id": 1,
"username": "admin",
"name": "Administrator", "name": "Administrator",
"username": "admin",
"state": "active", "state": "active",
"avatar_url": null, "avatar_url": null,
"web_url" : "https://gitlab.example.com/admin" "web_url" : "https://gitlab.example.com/admin"
}, },
"source_project_id": 2, "source_project_id": 2,
"target_project_id": 3, "target_project_id": 3,
"labels": [ ], "labels": [
"description": "fixed login page css paddings", "Community contribution",
"Manage"
],
"work_in_progress": false, "work_in_progress": false,
"milestone": { "milestone": {
"id": 5, "id": 5,
...@@ -208,24 +219,28 @@ Parameters: ...@@ -208,24 +219,28 @@ Parameters:
"state": "closed", "state": "closed",
"created_at": "2015-02-02T19:49:26.013Z", "created_at": "2015-02-02T19:49:26.013Z",
"updated_at": "2015-02-02T19:49:26.013Z", "updated_at": "2015-02-02T19:49:26.013Z",
"due_date": null "due_date": "2018-09-22",
"start_date": "2018-08-08",
"web_url": "https://gitlab.example.com/my-group/my-project/milestones/1"
}, },
"merge_when_pipeline_succeeds": true, "merge_when_pipeline_succeeds": true,
"merge_status": "can_be_merged", "merge_status": "can_be_merged",
"sha": "8888888888888888888888888888888888888888", "sha": "8888888888888888888888888888888888888888",
"merge_commit_sha": null, "merge_commit_sha": null,
"user_notes_count": 1, "user_notes_count": 1,
"discussion_locked": null,
"should_remove_source_branch": true, "should_remove_source_branch": true,
"force_remove_source_branch": false, "force_remove_source_branch": false,
"squash": false, "allow_collaboration": false,
"web_url": "http://example.com/example/example/merge_requests/1", "allow_maintainer_to_push": false,
"discussion_locked": false, "web_url": "http://gitlab.example.com/my-group/my-project/merge_requests/1",
"time_stats": { "time_stats": {
"time_estimate": 0, "time_estimate": 0,
"total_time_spent": 0, "total_time_spent": 0,
"human_time_estimate": null, "human_time_estimate": null,
"human_total_time_spent": null "human_total_time_spent": null
} },
"squash": false
} }
] ]
``` ```
...@@ -275,35 +290,38 @@ Parameters: ...@@ -275,35 +290,38 @@ Parameters:
{ {
"id": 1, "id": 1,
"iid": 1, "iid": 1,
"target_branch": "master",
"source_branch": "test1",
"project_id": 3, "project_id": 3,
"title": "test1", "title": "test1",
"description": "fixed login page css paddings",
"state": "opened", "state": "opened",
"created_at": "2017-04-29T08:46:00Z", "created_at": "2017-04-29T08:46:00Z",
"updated_at": "2017-04-29T08:46:00Z", "updated_at": "2017-04-29T08:46:00Z",
"target_branch": "master",
"source_branch": "test1",
"upvotes": 0, "upvotes": 0,
"downvotes": 0, "downvotes": 0,
"author": { "author": {
"id": 1, "id": 1,
"username": "admin",
"name": "Administrator", "name": "Administrator",
"username": "admin",
"state": "active", "state": "active",
"avatar_url": null, "avatar_url": null,
"web_url" : "https://gitlab.example.com/admin" "web_url" : "https://gitlab.example.com/admin"
}, },
"assignee": { "assignee": {
"id": 1, "id": 1,
"username": "admin",
"name": "Administrator", "name": "Administrator",
"username": "admin",
"state": "active", "state": "active",
"avatar_url": null, "avatar_url": null,
"web_url" : "https://gitlab.example.com/admin" "web_url" : "https://gitlab.example.com/admin"
}, },
"source_project_id": 2, "source_project_id": 2,
"target_project_id": 3, "target_project_id": 3,
"labels": [ ], "labels": [
"description": "fixed login page css paddings", "Community contribution",
"Manage"
],
"work_in_progress": false, "work_in_progress": false,
"milestone": { "milestone": {
"id": 5, "id": 5,
...@@ -314,23 +332,26 @@ Parameters: ...@@ -314,23 +332,26 @@ Parameters:
"state": "closed", "state": "closed",
"created_at": "2015-02-02T19:49:26.013Z", "created_at": "2015-02-02T19:49:26.013Z",
"updated_at": "2015-02-02T19:49:26.013Z", "updated_at": "2015-02-02T19:49:26.013Z",
"due_date": null "due_date": "2018-10-22",
"start_date": "2018-09-08",
"web_url": "gitlab.example.com/my-group/my-project/milestones/1"
}, },
"merge_when_pipeline_succeeds": true, "merge_when_pipeline_succeeds": true,
"merge_status": "can_be_merged", "merge_status": "can_be_merged",
"sha": "8888888888888888888888888888888888888888", "sha": "8888888888888888888888888888888888888888",
"merge_commit_sha": null, "merge_commit_sha": null,
"user_notes_count": 1, "user_notes_count": 1,
"discussion_locked": null,
"should_remove_source_branch": true, "should_remove_source_branch": true,
"force_remove_source_branch": false, "force_remove_source_branch": false,
"web_url": "http://example.com/example/example/merge_requests/1", "web_url": "http://gitlab.example.com/my-group/my-project/merge_requests/1",
"discussion_locked": false,
"time_stats": { "time_stats": {
"time_estimate": 0, "time_estimate": 0,
"total_time_spent": 0, "total_time_spent": 0,
"human_time_estimate": null, "human_time_estimate": null,
"human_total_time_spent": null "human_total_time_spent": null
} },
"squash": false
} }
] ]
``` ```
...@@ -359,35 +380,38 @@ Parameters: ...@@ -359,35 +380,38 @@ Parameters:
{ {
"id": 1, "id": 1,
"iid": 1, "iid": 1,
"target_branch": "master",
"source_branch": "test1",
"project_id": 3, "project_id": 3,
"title": "test1", "title": "test1",
"state": "merged", "description": "fixed login page css paddings",
"state": "opened",
"created_at": "2017-04-29T08:46:00Z", "created_at": "2017-04-29T08:46:00Z",
"updated_at": "2017-04-29T08:46:00Z", "updated_at": "2017-04-29T08:46:00Z",
"target_branch": "master",
"source_branch": "test1",
"upvotes": 0, "upvotes": 0,
"downvotes": 0, "downvotes": 0,
"author": { "author": {
"state" : "active", "id": 1,
"web_url" : "https://gitlab.example.com/root", "name": "Administrator",
"avatar_url" : null, "username": "admin",
"username" : "root", "state": "active",
"id" : 1, "avatar_url": null,
"name" : "Administrator" "web_url" : "https://gitlab.example.com/admin"
}, },
"assignee": { "assignee": {
"state" : "active", "id": 1,
"web_url" : "https://gitlab.example.com/root", "name": "Administrator",
"avatar_url" : null, "username": "admin",
"username" : "root", "state": "active",
"id" : 1, "avatar_url": null,
"name" : "Administrator" "web_url" : "https://gitlab.example.com/admin"
}, },
"source_project_id": 2, "source_project_id": 2,
"target_project_id": 3, "target_project_id": 3,
"labels": [ ], "labels": [
"description": "fixed login page css paddings", "Community contribution",
"Manage"
],
"work_in_progress": false, "work_in_progress": false,
"milestone": { "milestone": {
"id": 5, "id": 5,
...@@ -398,50 +422,55 @@ Parameters: ...@@ -398,50 +422,55 @@ Parameters:
"state": "closed", "state": "closed",
"created_at": "2015-02-02T19:49:26.013Z", "created_at": "2015-02-02T19:49:26.013Z",
"updated_at": "2015-02-02T19:49:26.013Z", "updated_at": "2015-02-02T19:49:26.013Z",
"due_date": null "due_date": "2018-09-22",
"start_date": "2018-08-08",
"web_url": "https://gitlab.example.com/my-group/my-project/milestones/1"
}, },
"merge_when_pipeline_succeeds": true, "merge_when_pipeline_succeeds": true,
"merge_status": "can_be_merged", "merge_status": "can_be_merged",
"subscribed" : true,
"sha": "8888888888888888888888888888888888888888", "sha": "8888888888888888888888888888888888888888",
"merge_commit_sha": "9999999999999999999999999999999999999999", "merge_commit_sha": null,
"user_notes_count": 1, "user_notes_count": 1,
"changes_count": "1", "discussion_locked": null,
"should_remove_source_branch": true, "should_remove_source_branch": true,
"force_remove_source_branch": false, "force_remove_source_branch": false,
"squash": false, "allow_collaboration": false,
"web_url": "http://example.com/example/example/merge_requests/1", "allow_maintainer_to_push": false,
"discussion_locked": false, "web_url": "http://gitlab.example.com/my-group/my-project/merge_requests/1",
"time_stats": { "time_stats": {
"time_estimate": 0, "time_estimate": 0,
"total_time_spent": 0, "total_time_spent": 0,
"human_time_estimate": null, "human_time_estimate": null,
"human_total_time_spent": null "human_total_time_spent": null
}, },
"closed_at": "2018-01-19T14:36:11.086Z", "squash": false,
"latest_build_started_at": null, "subscribed": false,
"latest_build_finished_at": null, "changes_count": "1",
"merged_by": {
"id": 87854,
"name": "Douwe Maan",
"username": "DouweM",
"state": "active",
"avatar_url": "https://gitlab.example.com/uploads/-/system/user/avatar/87854/avatar.png",
"web_url": "https://gitlab.com/DouweM"
},
"merged_at": "2018-09-07T11:16:17.520Z",
"closed_by": null,
"closed_at": null,
"latest_build_started_at": "2018-09-07T07:27:38.472Z",
"latest_build_finished_at": "2018-09-07T08:07:06.012Z",
"first_deployed_to_production_at": null, "first_deployed_to_production_at": null,
"pipeline": { "pipeline": {
"id": 8, "id": 29626725,
"ref": "master", "sha": "2be7ddb704c7b6b83732fdd5b9f09d5a397b5f8f",
"sha": "2dc6aa325a317eda67812f05600bdf0fcdc70ab0", "ref": "patch-28",
"status": "created" "status": "success",
}, "web_url": "https://gitlab.example.com/my-group/my-project/pipelines/29626725"
"merged_by": null,
"merged_at": null,
"closed_by": {
"state" : "active",
"web_url" : "https://gitlab.example.com/root",
"avatar_url" : null,
"username" : "root",
"id" : 1,
"name" : "Administrator"
}, },
"diff_refs": { "diff_refs": {
"base_sha": "1111111111111111111111111111111111111111", "base_sha": "c380d3acebd181f13629a25d2e2acca46ffe1e00",
"head_sha": "2222222222222222222222222222222222222222", "head_sha": "2be7ddb704c7b6b83732fdd5b9f09d5a397b5f8f",
"start_sha": "3333333333333333333333333333333333333333" "start_sha": "c380d3acebd181f13629a25d2e2acca46ffe1e00"
}, },
"diverged_commits_count": 2 "diverged_commits_count": 2
} }
...@@ -663,65 +692,99 @@ POST /projects/:id/merge_requests ...@@ -663,65 +692,99 @@ POST /projects/:id/merge_requests
{ {
"id": 1, "id": 1,
"iid": 1, "iid": 1,
"target_branch": "master", "project_id": 3,
"source_branch": "test1",
"project_id": 4,
"title": "test1", "title": "test1",
"description": "fixed login page css paddings",
"state": "opened", "state": "opened",
"created_at": "2017-04-29T08:46:00Z",
"updated_at": "2017-04-29T08:46:00Z",
"target_branch": "master",
"source_branch": "test1",
"upvotes": 0, "upvotes": 0,
"downvotes": 0, "downvotes": 0,
"author": { "author": {
"id": 1, "id": 1,
"username": "admin",
"name": "Administrator", "name": "Administrator",
"username": "admin",
"state": "active", "state": "active",
"avatar_url": null, "avatar_url": null,
"web_url" : "https://gitlab.example.com/admin" "web_url" : "https://gitlab.example.com/admin"
}, },
"assignee": { "assignee": {
"id": 1, "id": 1,
"username": "admin",
"name": "Administrator", "name": "Administrator",
"username": "admin",
"state": "active", "state": "active",
"avatar_url": null, "avatar_url": null,
"web_url" : "https://gitlab.example.com/admin" "web_url" : "https://gitlab.example.com/admin"
}, },
"source_project_id": 3, "source_project_id": 2,
"target_project_id": 4, "target_project_id": 3,
"labels": [ ], "labels": [
"description": "fixed login page css paddings", "Community contribution",
"Manage"
],
"work_in_progress": false, "work_in_progress": false,
"milestone": { "milestone": {
"id": 5, "id": 5,
"iid": 1, "iid": 1,
"project_id": 4, "project_id": 3,
"title": "v2.0", "title": "v2.0",
"description": "Assumenda aut placeat expedita exercitationem labore sunt enim earum.", "description": "Assumenda aut placeat expedita exercitationem labore sunt enim earum.",
"state": "closed", "state": "closed",
"created_at": "2015-02-02T19:49:26.013Z", "created_at": "2015-02-02T19:49:26.013Z",
"updated_at": "2015-02-02T19:49:26.013Z", "updated_at": "2015-02-02T19:49:26.013Z",
"due_date": null "due_date": "2018-09-22",
"start_date": "2018-08-08",
"web_url": "https://gitlab.example.com/my-group/my-project/milestones/1"
}, },
"merge_when_pipeline_succeeds": true, "merge_when_pipeline_succeeds": true,
"merge_status": "can_be_merged", "merge_status": "can_be_merged",
"subscribed" : true,
"sha": "8888888888888888888888888888888888888888", "sha": "8888888888888888888888888888888888888888",
"merge_commit_sha": null, "merge_commit_sha": null,
"user_notes_count": 0, "user_notes_count": 1,
"changes_count": "1", "discussion_locked": null,
"should_remove_source_branch": true, "should_remove_source_branch": true,
"force_remove_source_branch": false, "force_remove_source_branch": false,
"squash": false,
"web_url": "http://example.com/example/example/merge_requests/1",
"discussion_locked": false,
"allow_collaboration": false, "allow_collaboration": false,
"allow_maintainer_to_push": false, "allow_maintainer_to_push": false,
"web_url": "http://gitlab.example.com/my-group/my-project/merge_requests/1",
"time_stats": { "time_stats": {
"time_estimate": 0, "time_estimate": 0,
"total_time_spent": 0, "total_time_spent": 0,
"human_time_estimate": null, "human_time_estimate": null,
"human_total_time_spent": null "human_total_time_spent": null
} },
"squash": false,
"subscribed": false,
"changes_count": "1",
"merged_by": {
"id": 87854,
"name": "Douwe Maan",
"username": "DouweM",
"state": "active",
"avatar_url": "https://gitlab.example.com/uploads/-/system/user/avatar/87854/avatar.png",
"web_url": "https://gitlab.com/DouweM"
},
"merged_at": "2018-09-07T11:16:17.520Z",
"closed_by": null,
"closed_at": null,
"latest_build_started_at": "2018-09-07T07:27:38.472Z",
"latest_build_finished_at": "2018-09-07T08:07:06.012Z",
"first_deployed_to_production_at": null,
"pipeline": {
"id": 29626725,
"sha": "2be7ddb704c7b6b83732fdd5b9f09d5a397b5f8f",
"ref": "patch-28",
"status": "success",
"web_url": "https://gitlab.example.com/my-group/my-project/pipelines/29626725"
},
"diff_refs": {
"base_sha": "c380d3acebd181f13629a25d2e2acca46ffe1e00",
"head_sha": "2be7ddb704c7b6b83732fdd5b9f09d5a397b5f8f",
"start_sha": "c380d3acebd181f13629a25d2e2acca46ffe1e00"
},
"diverged_commits_count": 2
} }
``` ```
...@@ -756,64 +819,99 @@ Must include at least one non-required attribute from above. ...@@ -756,64 +819,99 @@ Must include at least one non-required attribute from above.
{ {
"id": 1, "id": 1,
"iid": 1, "iid": 1,
"target_branch": "master", "project_id": 3,
"project_id": 4,
"title": "test1", "title": "test1",
"description": "fixed login page css paddings",
"state": "opened", "state": "opened",
"created_at": "2017-04-29T08:46:00Z",
"updated_at": "2017-04-29T08:46:00Z",
"target_branch": "master",
"source_branch": "test1",
"upvotes": 0, "upvotes": 0,
"downvotes": 0, "downvotes": 0,
"author": { "author": {
"id": 1, "id": 1,
"username": "admin",
"name": "Administrator", "name": "Administrator",
"username": "admin",
"state": "active", "state": "active",
"avatar_url": null, "avatar_url": null,
"web_url" : "https://gitlab.example.com/admin" "web_url" : "https://gitlab.example.com/admin"
}, },
"assignee": { "assignee": {
"id": 1, "id": 1,
"username": "admin",
"name": "Administrator", "name": "Administrator",
"username": "admin",
"state": "active", "state": "active",
"avatar_url": null, "avatar_url": null,
"web_url" : "https://gitlab.example.com/admin" "web_url" : "https://gitlab.example.com/admin"
}, },
"source_project_id": 3, "source_project_id": 2,
"target_project_id": 4, "target_project_id": 3,
"labels": [ ], "labels": [
"description": "description1", "Community contribution",
"Manage"
],
"work_in_progress": false, "work_in_progress": false,
"milestone": { "milestone": {
"id": 5, "id": 5,
"iid": 1, "iid": 1,
"project_id": 4, "project_id": 3,
"title": "v2.0", "title": "v2.0",
"description": "Assumenda aut placeat expedita exercitationem labore sunt enim earum.", "description": "Assumenda aut placeat expedita exercitationem labore sunt enim earum.",
"state": "closed", "state": "closed",
"created_at": "2015-02-02T19:49:26.013Z", "created_at": "2015-02-02T19:49:26.013Z",
"updated_at": "2015-02-02T19:49:26.013Z", "updated_at": "2015-02-02T19:49:26.013Z",
"due_date": null "due_date": "2018-09-22",
"start_date": "2018-08-08",
"web_url": "https://gitlab.example.com/my-group/my-project/milestones/1"
}, },
"merge_when_pipeline_succeeds": true, "merge_when_pipeline_succeeds": true,
"merge_status": "can_be_merged", "merge_status": "can_be_merged",
"subscribed" : true,
"sha": "8888888888888888888888888888888888888888", "sha": "8888888888888888888888888888888888888888",
"merge_commit_sha": null, "merge_commit_sha": null,
"user_notes_count": 1, "user_notes_count": 1,
"changes_count": "1", "discussion_locked": null,
"should_remove_source_branch": true, "should_remove_source_branch": true,
"force_remove_source_branch": false, "force_remove_source_branch": false,
"squash": false,
"web_url": "http://example.com/example/example/merge_requests/1",
"discussion_locked": false,
"allow_collaboration": false, "allow_collaboration": false,
"allow_maintainer_to_push": false, "allow_maintainer_to_push": false,
"web_url": "http://gitlab.example.com/my-group/my-project/merge_requests/1",
"time_stats": { "time_stats": {
"time_estimate": 0, "time_estimate": 0,
"total_time_spent": 0, "total_time_spent": 0,
"human_time_estimate": null, "human_time_estimate": null,
"human_total_time_spent": null "human_total_time_spent": null
} },
"squash": false,
"subscribed": false,
"changes_count": "1",
"merged_by": {
"id": 87854,
"name": "Douwe Maan",
"username": "DouweM",
"state": "active",
"avatar_url": "https://gitlab.example.com/uploads/-/system/user/avatar/87854/avatar.png",
"web_url": "https://gitlab.com/DouweM"
},
"merged_at": "2018-09-07T11:16:17.520Z",
"closed_by": null,
"closed_at": null,
"latest_build_started_at": "2018-09-07T07:27:38.472Z",
"latest_build_finished_at": "2018-09-07T08:07:06.012Z",
"first_deployed_to_production_at": null,
"pipeline": {
"id": 29626725,
"sha": "2be7ddb704c7b6b83732fdd5b9f09d5a397b5f8f",
"ref": "patch-28",
"status": "success",
"web_url": "https://gitlab.example.com/my-group/my-project/pipelines/29626725"
},
"diff_refs": {
"base_sha": "c380d3acebd181f13629a25d2e2acca46ffe1e00",
"head_sha": "2be7ddb704c7b6b83732fdd5b9f09d5a397b5f8f",
"start_sha": "c380d3acebd181f13629a25d2e2acca46ffe1e00"
},
"diverged_commits_count": 2
} }
``` ```
...@@ -857,70 +955,106 @@ Parameters: ...@@ -857,70 +955,106 @@ Parameters:
- `merge_request_iid` (required) - Internal ID of MR - `merge_request_iid` (required) - Internal ID of MR
- `merge_commit_message` (optional) - Custom merge commit message - `merge_commit_message` (optional) - Custom merge commit message
- `should_remove_source_branch` (optional) - if `true` removes the source branch - `should_remove_source_branch` (optional) - if `true` removes the source branch
- `merge_when_pipeline_succeeds` (optional) - if `true` the MR is merged when the pipeline succeeds - `merge_when_pipeline_succeeds` (optional) - if `true` the MR is merged when the pipeline succeeds
- `sha` (optional) - if present, then this SHA must match the HEAD of the source branch, otherwise the merge will fail - `sha` (optional) - if present, then this SHA must match the HEAD of the source branch, otherwise the merge will fail
```json ```json
{ {
"id": 1, "id": 1,
"iid": 1, "iid": 1,
"target_branch": "master",
"source_branch": "test1",
"project_id": 3, "project_id": 3,
"title": "test1", "title": "test1",
"state": "merged", "description": "fixed login page css paddings",
"state": "opened",
"created_at": "2017-04-29T08:46:00Z",
"updated_at": "2017-04-29T08:46:00Z",
"target_branch": "master",
"source_branch": "test1",
"upvotes": 0, "upvotes": 0,
"downvotes": 0, "downvotes": 0,
"author": { "author": {
"id": 1, "id": 1,
"username": "admin",
"name": "Administrator", "name": "Administrator",
"username": "admin",
"state": "active", "state": "active",
"avatar_url": null, "avatar_url": null,
"web_url" : "https://gitlab.example.com/admin" "web_url" : "https://gitlab.example.com/admin"
}, },
"assignee": { "assignee": {
"id": 1, "id": 1,
"username": "admin",
"name": "Administrator", "name": "Administrator",
"username": "admin",
"state": "active", "state": "active",
"avatar_url": null, "avatar_url": null,
"web_url" : "https://gitlab.example.com/admin" "web_url" : "https://gitlab.example.com/admin"
}, },
"source_project_id": 4, "source_project_id": 2,
"target_project_id": 4, "target_project_id": 3,
"labels": [ ], "labels": [
"description": "fixed login page css paddings", "Community contribution",
"Manage"
],
"work_in_progress": false, "work_in_progress": false,
"milestone": { "milestone": {
"id": 5, "id": 5,
"iid": 1, "iid": 1,
"project_id": 4, "project_id": 3,
"title": "v2.0", "title": "v2.0",
"description": "Assumenda aut placeat expedita exercitationem labore sunt enim earum.", "description": "Assumenda aut placeat expedita exercitationem labore sunt enim earum.",
"state": "closed", "state": "closed",
"created_at": "2015-02-02T19:49:26.013Z", "created_at": "2015-02-02T19:49:26.013Z",
"updated_at": "2015-02-02T19:49:26.013Z", "updated_at": "2015-02-02T19:49:26.013Z",
"due_date": null "due_date": "2018-09-22",
"start_date": "2018-08-08",
"web_url": "https://gitlab.example.com/my-group/my-project/milestones/1"
}, },
"merge_when_pipeline_succeeds": true, "merge_when_pipeline_succeeds": true,
"merge_status": "can_be_merged", "merge_status": "can_be_merged",
"subscribed" : true,
"sha": "8888888888888888888888888888888888888888", "sha": "8888888888888888888888888888888888888888",
"merge_commit_sha": "9999999999999999999999999999999999999999", "merge_commit_sha": null,
"user_notes_count": 1, "user_notes_count": 1,
"changes_count": "1", "discussion_locked": null,
"should_remove_source_branch": true, "should_remove_source_branch": true,
"force_remove_source_branch": false, "force_remove_source_branch": false,
"squash": false, "allow_collaboration": false,
"web_url": "http://example.com/example/example/merge_requests/1", "allow_maintainer_to_push": false,
"discussion_locked": false, "web_url": "http://gitlab.example.com/my-group/my-project/merge_requests/1",
"time_stats": { "time_stats": {
"time_estimate": 0, "time_estimate": 0,
"total_time_spent": 0, "total_time_spent": 0,
"human_time_estimate": null, "human_time_estimate": null,
"human_total_time_spent": null "human_total_time_spent": null
} },
"squash": false,
"subscribed": false,
"changes_count": "1",
"merged_by": {
"id": 87854,
"name": "Douwe Maan",
"username": "DouweM",
"state": "active",
"avatar_url": "https://gitlab.example.com/uploads/-/system/user/avatar/87854/avatar.png",
"web_url": "https://gitlab.com/DouweM"
},
"merged_at": "2018-09-07T11:16:17.520Z",
"closed_by": null,
"closed_at": null,
"latest_build_started_at": "2018-09-07T07:27:38.472Z",
"latest_build_finished_at": "2018-09-07T08:07:06.012Z",
"first_deployed_to_production_at": null,
"pipeline": {
"id": 29626725,
"sha": "2be7ddb704c7b6b83732fdd5b9f09d5a397b5f8f",
"ref": "patch-28",
"status": "success",
"web_url": "https://gitlab.example.com/my-group/my-project/pipelines/29626725"
},
"diff_refs": {
"base_sha": "c380d3acebd181f13629a25d2e2acca46ffe1e00",
"head_sha": "2be7ddb704c7b6b83732fdd5b9f09d5a397b5f8f",
"start_sha": "c380d3acebd181f13629a25d2e2acca46ffe1e00"
},
"diverged_commits_count": 2
} }
``` ```
...@@ -937,69 +1071,105 @@ PUT /projects/:id/merge_requests/:merge_request_iid/cancel_merge_when_pipeline_s ...@@ -937,69 +1071,105 @@ PUT /projects/:id/merge_requests/:merge_request_iid/cancel_merge_when_pipeline_s
Parameters: Parameters:
- `id` (required) - The ID or [URL-encoded path of the project](README.md#namespaced-path-encoding) owned by the authenticated user - `id` (required) - The ID or [URL-encoded path of the project](README.md#namespaced-path-encoding) owned by the authenticated user
- `merge_request_iid` (required) - Internal ID of MR - `merge_request_iid` (required) - Internal ID of MR
```json ```json
{ {
"id": 1, "id": 1,
"iid": 1, "iid": 1,
"target_branch": "master",
"source_branch": "test1",
"project_id": 3, "project_id": 3,
"title": "test1", "title": "test1",
"description": "fixed login page css paddings",
"state": "opened", "state": "opened",
"created_at": "2017-04-29T08:46:00Z",
"updated_at": "2017-04-29T08:46:00Z",
"target_branch": "master",
"source_branch": "test1",
"upvotes": 0, "upvotes": 0,
"downvotes": 0, "downvotes": 0,
"author": { "author": {
"id": 1, "id": 1,
"username": "admin",
"name": "Administrator", "name": "Administrator",
"username": "admin",
"state": "active", "state": "active",
"avatar_url": null, "avatar_url": null,
"web_url" : "https://gitlab.example.com/admin" "web_url" : "https://gitlab.example.com/admin"
}, },
"assignee": { "assignee": {
"id": 1, "id": 1,
"username": "admin",
"name": "Administrator", "name": "Administrator",
"username": "admin",
"state": "active", "state": "active",
"avatar_url": null, "avatar_url": null,
"web_url" : "https://gitlab.example.com/admin" "web_url" : "https://gitlab.example.com/admin"
}, },
"source_project_id": 4, "source_project_id": 2,
"target_project_id": 4, "target_project_id": 3,
"labels": [ ], "labels": [
"description": "fixed login page css paddings", "Community contribution",
"Manage"
],
"work_in_progress": false, "work_in_progress": false,
"milestone": { "milestone": {
"id": 5, "id": 5,
"iid": 1, "iid": 1,
"project_id": 4, "project_id": 3,
"title": "v2.0", "title": "v2.0",
"description": "Assumenda aut placeat expedita exercitationem labore sunt enim earum.", "description": "Assumenda aut placeat expedita exercitationem labore sunt enim earum.",
"state": "closed", "state": "closed",
"created_at": "2015-02-02T19:49:26.013Z", "created_at": "2015-02-02T19:49:26.013Z",
"updated_at": "2015-02-02T19:49:26.013Z", "updated_at": "2015-02-02T19:49:26.013Z",
"due_date": null "due_date": "2018-09-22",
"start_date": "2018-08-08",
"web_url": "https://gitlab.example.com/my-group/my-project/milestones/1"
}, },
"merge_when_pipeline_succeeds": true, "merge_when_pipeline_succeeds": false,
"merge_status": "can_be_merged", "merge_status": "can_be_merged",
"subscribed" : true,
"sha": "8888888888888888888888888888888888888888", "sha": "8888888888888888888888888888888888888888",
"merge_commit_sha": null, "merge_commit_sha": null,
"user_notes_count": 1, "user_notes_count": 1,
"changes_count": "1", "discussion_locked": null,
"should_remove_source_branch": true, "should_remove_source_branch": true,
"force_remove_source_branch": false, "force_remove_source_branch": false,
"squash": false, "allow_collaboration": false,
"web_url": "http://example.com/example/example/merge_requests/1", "allow_maintainer_to_push": false,
"discussion_locked": false, "web_url": "http://gitlab.example.com/my-group/my-project/merge_requests/1",
"time_stats": { "time_stats": {
"time_estimate": 0, "time_estimate": 0,
"total_time_spent": 0, "total_time_spent": 0,
"human_time_estimate": null, "human_time_estimate": null,
"human_total_time_spent": null "human_total_time_spent": null
} },
"squash": false,
"subscribed": false,
"changes_count": "1",
"merged_by": {
"id": 87854,
"name": "Douwe Maan",
"username": "DouweM",
"state": "active",
"avatar_url": "https://gitlab.example.com/uploads/-/system/user/avatar/87854/avatar.png",
"web_url": "https://gitlab.com/DouweM"
},
"merged_at": "2018-09-07T11:16:17.520Z",
"closed_by": null,
"closed_at": null,
"latest_build_started_at": "2018-09-07T07:27:38.472Z",
"latest_build_finished_at": "2018-09-07T08:07:06.012Z",
"first_deployed_to_production_at": null,
"pipeline": {
"id": 29626725,
"sha": "2be7ddb704c7b6b83732fdd5b9f09d5a397b5f8f",
"ref": "patch-28",
"status": "success",
"web_url": "https://gitlab.example.com/my-group/my-project/pipelines/29626725"
},
"diff_refs": {
"base_sha": "c380d3acebd181f13629a25d2e2acca46ffe1e00",
"head_sha": "2be7ddb704c7b6b83732fdd5b9f09d5a397b5f8f",
"start_sha": "c380d3acebd181f13629a25d2e2acca46ffe1e00"
},
"diverged_commits_count": 2
} }
``` ```
...@@ -1067,7 +1237,7 @@ Example response when the GitLab issue tracker is used: ...@@ -1067,7 +1237,7 @@ Example response when the GitLab issue tracker is used:
"labels" : [], "labels" : [],
"user_notes_count": 1, "user_notes_count": 1,
"changes_count": "1" "changes_count": "1"
}, }
] ]
``` ```
...@@ -1104,54 +1274,101 @@ Example response: ...@@ -1104,54 +1274,101 @@ Example response:
```json ```json
{ {
"id": 17, "id": 1,
"iid": 1, "iid": 1,
"project_id": 5, "project_id": 3,
"title": "Et et sequi est impedit nulla ut rem et voluptatem.", "title": "test1",
"description": "Consequatur velit eos rerum optio autem. Quia id officia quaerat dolorum optio. Illo laudantium aut ipsum dolorem.", "description": "fixed login page css paddings",
"state": "opened", "state": "opened",
"created_at": "2016-04-05T21:42:23.233Z", "created_at": "2017-04-29T08:46:00Z",
"updated_at": "2016-04-05T22:11:52.900Z", "updated_at": "2017-04-29T08:46:00Z",
"target_branch": "ui-dev-kit", "target_branch": "master",
"source_branch": "version-1-9", "source_branch": "test1",
"upvotes": 0, "upvotes": 0,
"downvotes": 0, "downvotes": 0,
"author": { "author": {
"name": "Eileen Skiles", "id": 1,
"username": "leila", "name": "Administrator",
"id": 19, "username": "admin",
"state": "active", "state": "active",
"avatar_url": "http://www.gravatar.com/avatar/39ce4a2822cc896933ffbd68c1470e55?s=80&d=identicon", "avatar_url": null,
"web_url": "https://gitlab.example.com/leila" "web_url" : "https://gitlab.example.com/admin"
}, },
"assignee": { "assignee": {
"name": "Celine Wehner", "id": 1,
"username": "carli", "name": "Administrator",
"id": 16, "username": "admin",
"state": "active", "state": "active",
"avatar_url": "http://www.gravatar.com/avatar/f4cd5605b769dd2ce405a27c6e6f2684?s=80&d=identicon", "avatar_url": null,
"web_url": "https://gitlab.example.com/carli" "web_url" : "https://gitlab.example.com/admin"
}, },
"source_project_id": 5, "source_project_id": 2,
"target_project_id": 5, "target_project_id": 3,
"labels": [], "labels": [
"Community contribution",
"Manage"
],
"work_in_progress": false, "work_in_progress": false,
"milestone": { "milestone": {
"id": 7, "id": 5,
"iid": 1, "iid": 1,
"project_id": 5, "project_id": 3,
"title": "v2.0", "title": "v2.0",
"description": "Corrupti eveniet et velit occaecati dolorem est rerum aut.", "description": "Assumenda aut placeat expedita exercitationem labore sunt enim earum.",
"state": "closed", "state": "closed",
"created_at": "2016-04-05T21:41:40.905Z", "created_at": "2015-02-02T19:49:26.013Z",
"updated_at": "2016-04-05T21:41:40.905Z", "updated_at": "2015-02-02T19:49:26.013Z",
"due_date": null "due_date": "2018-09-22",
"start_date": "2018-08-08",
"web_url": "https://gitlab.example.com/my-group/my-project/milestones/1"
}, },
"merge_when_pipeline_succeeds": false, "merge_when_pipeline_succeeds": true,
"merge_status": "cannot_be_merged", "merge_status": "can_be_merged",
"subscribed": true,
"sha": "8888888888888888888888888888888888888888", "sha": "8888888888888888888888888888888888888888",
"merge_commit_sha": null "merge_commit_sha": null,
"user_notes_count": 1,
"discussion_locked": null,
"should_remove_source_branch": true,
"force_remove_source_branch": false,
"allow_collaboration": false,
"allow_maintainer_to_push": false,
"web_url": "http://gitlab.example.com/my-group/my-project/merge_requests/1",
"time_stats": {
"time_estimate": 0,
"total_time_spent": 0,
"human_time_estimate": null,
"human_total_time_spent": null
},
"squash": false,
"subscribed": false,
"changes_count": "1",
"merged_by": {
"id": 87854,
"name": "Douwe Maan",
"username": "DouweM",
"state": "active",
"avatar_url": "https://gitlab.example.com/uploads/-/system/user/avatar/87854/avatar.png",
"web_url": "https://gitlab.com/DouweM"
},
"merged_at": "2018-09-07T11:16:17.520Z",
"closed_by": null,
"closed_at": null,
"latest_build_started_at": "2018-09-07T07:27:38.472Z",
"latest_build_finished_at": "2018-09-07T08:07:06.012Z",
"first_deployed_to_production_at": null,
"pipeline": {
"id": 29626725,
"sha": "2be7ddb704c7b6b83732fdd5b9f09d5a397b5f8f",
"ref": "patch-28",
"status": "success",
"web_url": "https://gitlab.example.com/my-group/my-project/pipelines/29626725"
},
"diff_refs": {
"base_sha": "c380d3acebd181f13629a25d2e2acca46ffe1e00",
"head_sha": "2be7ddb704c7b6b83732fdd5b9f09d5a397b5f8f",
"start_sha": "c380d3acebd181f13629a25d2e2acca46ffe1e00"
},
"diverged_commits_count": 2
} }
``` ```
...@@ -1178,54 +1395,101 @@ Example response: ...@@ -1178,54 +1395,101 @@ Example response:
```json ```json
{ {
"id": 17, "id": 1,
"iid": 1, "iid": 1,
"project_id": 5, "project_id": 3,
"title": "Et et sequi est impedit nulla ut rem et voluptatem.", "title": "test1",
"description": "Consequatur velit eos rerum optio autem. Quia id officia quaerat dolorum optio. Illo laudantium aut ipsum dolorem.", "description": "fixed login page css paddings",
"state": "opened", "state": "opened",
"created_at": "2016-04-05T21:42:23.233Z", "created_at": "2017-04-29T08:46:00Z",
"updated_at": "2016-04-05T22:11:52.900Z", "updated_at": "2017-04-29T08:46:00Z",
"target_branch": "ui-dev-kit", "target_branch": "master",
"source_branch": "version-1-9", "source_branch": "test1",
"upvotes": 0, "upvotes": 0,
"downvotes": 0, "downvotes": 0,
"author": { "author": {
"name": "Eileen Skiles", "id": 1,
"username": "leila", "name": "Administrator",
"id": 19, "username": "admin",
"state": "active", "state": "active",
"avatar_url": "http://www.gravatar.com/avatar/39ce4a2822cc896933ffbd68c1470e55?s=80&d=identicon", "avatar_url": null,
"web_url": "https://gitlab.example.com/leila" "web_url" : "https://gitlab.example.com/admin"
}, },
"assignee": { "assignee": {
"name": "Celine Wehner", "id": 1,
"username": "carli", "name": "Administrator",
"id": 16, "username": "admin",
"state": "active", "state": "active",
"avatar_url": "http://www.gravatar.com/avatar/f4cd5605b769dd2ce405a27c6e6f2684?s=80&d=identicon", "avatar_url": null,
"web_url": "https://gitlab.example.com/carli" "web_url" : "https://gitlab.example.com/admin"
}, },
"source_project_id": 5, "source_project_id": 2,
"target_project_id": 5, "target_project_id": 3,
"labels": [], "labels": [
"Community contribution",
"Manage"
],
"work_in_progress": false, "work_in_progress": false,
"milestone": { "milestone": {
"id": 7, "id": 5,
"iid": 1, "iid": 1,
"project_id": 5, "project_id": 3,
"title": "v2.0", "title": "v2.0",
"description": "Corrupti eveniet et velit occaecati dolorem est rerum aut.", "description": "Assumenda aut placeat expedita exercitationem labore sunt enim earum.",
"state": "closed", "state": "closed",
"created_at": "2016-04-05T21:41:40.905Z", "created_at": "2015-02-02T19:49:26.013Z",
"updated_at": "2016-04-05T21:41:40.905Z", "updated_at": "2015-02-02T19:49:26.013Z",
"due_date": null "due_date": "2018-09-22",
"start_date": "2018-08-08",
"web_url": "https://gitlab.example.com/my-group/my-project/milestones/1"
}, },
"merge_when_pipeline_succeeds": false, "merge_when_pipeline_succeeds": true,
"merge_status": "cannot_be_merged", "merge_status": "can_be_merged",
"subscribed": false,
"sha": "8888888888888888888888888888888888888888", "sha": "8888888888888888888888888888888888888888",
"merge_commit_sha": null "merge_commit_sha": null,
"user_notes_count": 1,
"discussion_locked": null,
"should_remove_source_branch": true,
"force_remove_source_branch": false,
"allow_collaboration": false,
"allow_maintainer_to_push": false,
"web_url": "http://gitlab.example.com/my-group/my-project/merge_requests/1",
"time_stats": {
"time_estimate": 0,
"total_time_spent": 0,
"human_time_estimate": null,
"human_total_time_spent": null
},
"squash": false,
"subscribed": false,
"changes_count": "1",
"merged_by": {
"id": 87854,
"name": "Douwe Maan",
"username": "DouweM",
"state": "active",
"avatar_url": "https://gitlab.example.com/uploads/-/system/user/avatar/87854/avatar.png",
"web_url": "https://gitlab.com/DouweM"
},
"merged_at": "2018-09-07T11:16:17.520Z",
"closed_by": null,
"closed_at": null,
"latest_build_started_at": "2018-09-07T07:27:38.472Z",
"latest_build_finished_at": "2018-09-07T08:07:06.012Z",
"first_deployed_to_production_at": null,
"pipeline": {
"id": 29626725,
"sha": "2be7ddb704c7b6b83732fdd5b9f09d5a397b5f8f",
"ref": "patch-28",
"status": "success",
"web_url": "https://gitlab.example.com/my-group/my-project/pipelines/29626725"
},
"diff_refs": {
"base_sha": "c380d3acebd181f13629a25d2e2acca46ffe1e00",
"head_sha": "2be7ddb704c7b6b83732fdd5b9f09d5a397b5f8f",
"start_sha": "c380d3acebd181f13629a25d2e2acca46ffe1e00"
},
"diverged_commits_count": 2
} }
``` ```
......
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment
GitLab Nexedi Edition | About GitLab | About Nexedi | 沪ICP备2021021310号-2 | 沪ICP备2021021310号-7