2020-07-30 12:09:33 +00:00
---
stage: Create
2021-02-22 06:10:57 +00:00
group: Code Review
2020-11-26 06:09:20 +00:00
info: "To determine the technical writer assigned to the Stage/Group associated with this page, see https://about.gitlab.com/handbook/engineering/ux/technical-writing/#assignments"
2020-07-30 12:09:33 +00:00
type: reference, api
---
2021-02-09 18:09:59 +00:00
# Merge request context commits API **(FREE)**
2020-01-29 15:08:59 +00:00
## List MR context commits
Get a list of merge request context commits.
2020-02-27 09:09:01 +00:00
```plaintext
2020-01-29 15:08:59 +00:00
GET /projects/:id/merge_requests/:merge_request_iid/context_commits
```
Parameters:
2021-11-22 18:10:55 +00:00
| Attribute | Type | Required | Description |
|---------------------|---------|----------|-----------------------------------------------------------------------------------------------------------------|
| `id` | integer | yes | The ID or [URL-encoded path of the project ](index.md#namespaced-path-encoding ) owned by the authenticated user |
| `merge_request_iid` | integer | yes | The internal ID of the merge request |
2020-01-29 15:08:59 +00:00
```json
[
{
"id": "4a24d82dbca5c11c61556f3b35ca472b7463187e",
"short_id": "4a24d82d",
"created_at": "2017-04-11T10:08:59.000Z",
"parent_ids": null,
"title": "Update README.md to include `Usage in testing and development` ",
"message": "Update README.md to include `Usage in testing and development` ",
2020-03-04 03:08:50 +00:00
"author_name": "Example \"Sample\" User",
"author_email": "user@example.com",
2020-01-29 15:08:59 +00:00
"authored_date": "2017-04-11T10:08:59.000Z",
2020-03-04 03:08:50 +00:00
"committer_name": "Example \"Sample\" User",
"committer_email": "user@example.com",
2020-01-30 15:09:15 +00:00
"committed_date": "2017-04-11T10:08:59.000Z"
2020-01-29 15:08:59 +00:00
}
]
```
## Create MR context commits
Create a list of merge request context commits.
2020-02-27 09:09:01 +00:00
```plaintext
2020-01-29 15:08:59 +00:00
POST /projects/:id/merge_requests/:merge_request_iid/context_commits
```
Parameters:
2021-11-22 18:10:55 +00:00
| Attribute | Type | Required | Description |
|---------------------|---------|----------|-----------------------------------------------------------------------------------------------------------------|
| `id` | integer | yes | The ID or [URL-encoded path of the project ](index.md#namespaced-path-encoding ) owned by the authenticated user |
| `merge_request_iid` | integer | yes | The internal ID of the merge request |
2020-01-29 15:08:59 +00:00
2020-02-27 09:09:01 +00:00
```plaintext
2020-01-29 15:08:59 +00:00
POST /projects/:id/merge_requests/
```
| Attribute | Type | Required | Description |
| --------- | ---- | -------- | ----------- |
2020-03-26 03:07:43 +00:00
| `commits` | string array | yes | The context commits' SHA |
2020-01-29 15:08:59 +00:00
```json
[
{
"id": "6d394385cf567f80a8fd85055db1ab4c5295806f",
2020-03-04 03:08:50 +00:00
"message": "Added contributing guide\n\nSigned-off-by: Example User < user @ example . com > \n",
2020-01-29 15:08:59 +00:00
"parent_ids": [
"1a0b36b3cdad1d2ee32457c102a8c0b7056fa863"
],
"authored_date": "2014-02-27T10:05:10.000+02:00",
2020-03-04 03:08:50 +00:00
"author_name": "Example User",
"author_email": "user@example.com",
2020-01-29 15:08:59 +00:00
"committed_date": "2014-02-27T10:05:10.000+02:00",
2020-03-04 03:08:50 +00:00
"committer_name": "Example User",
"committer_email": "user@example.com"
2020-01-29 15:08:59 +00:00
}
]
```
## Delete MR context commits
Delete a list of merge request context commits.
2020-02-27 09:09:01 +00:00
```plaintext
2020-01-29 15:08:59 +00:00
DELETE /projects/:id/merge_requests/:merge_request_iid/context_commits
```
Parameters:
2021-11-22 18:10:55 +00:00
| Attribute | Type | Required | Description |
|---------------------|--------------|----------|-----------------------------------------------------------------------------------------------------------------|
| `id` | integer | yes | The ID or [URL-encoded path of the project ](index.md#namespaced-path-encoding ) owned by the authenticated user |
| `merge_request_iid` | integer | yes | The internal ID of the merge request |
| `commits` | string array | yes | The context commits' SHA |
