Merge request context commits API

  • Tier: Free, Premium, Ultimate
  • Offering: GitLab.com, GitLab Self-Managed, GitLab Dedicated

If your merge request builds upon a previous merge request, you might need to include previously-merged commits for context. Use this API to add commits to a merge request for more context.

List MR context commits

Get a list of merge request context commits.

GET /projects/:id/merge_requests/:merge_request_iid/context_commits

Parameters:

AttributeTypeRequiredDescription
idintegerYesThe ID or URL-encoded path of the project.
merge_request_iidintegerYesThe internal ID of the merge request.
[
    {
        "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`",
        "author_name": "Example \"Sample\" User",
        "author_email": "user@example.com",
        "authored_date": "2017-04-11T10:08:59.000Z",
        "committer_name": "Example \"Sample\" User",
        "committer_email": "user@example.com",
        "committed_date": "2017-04-11T10:08:59.000Z"
    }
]

Create MR context commits

Create a list of merge request context commits.

POST /projects/:id/merge_requests/:merge_request_iid/context_commits

Parameters:

AttributeTypeRequiredDescription
idintegerYesThe ID or URL-encoded path of the project
merge_request_iidintegerYesThe internal ID of the merge request.
commitsstring arrayYesThe context commits’ SHAs.

Example request:

curl --request POST --header "PRIVATE-TOKEN: <your_access_token>" \
  --header 'Content-Type: application/json' \
  --data '{"commits": ["51856a574ac3302a95f82483d6c7396b1e0783cb"]}' \
  --url "https://gitlab.example.com/api/v4/projects/15/merge_requests/12/context_commits"

Example response:

[
    {
        "id": "51856a574ac3302a95f82483d6c7396b1e0783cb",
        "short_id": "51856a57",
        "created_at": "2014-02-27T10:05:10.000+02:00",
        "parent_ids": [
            "57a82e2180507c9e12880c0747f0ea65ad489515"
        ],
        "title": "Commit title",
        "message": "Commit message",
        "author_name": "Example User",
        "author_email": "user@example.com",
        "authored_date": "2014-02-27T10:05:10.000+02:00",
        "committer_name": "Example User",
        "committer_email": "user@example.com",
        "committed_date": "2014-02-27T10:05:10.000+02:00",
        "trailers": {},
        "web_url": "https://gitlab.example.com/project/path/-/commit/b782f6c553653ab4e16469ff34bf3a81638ac304"
    }
]

Delete MR context commits

Delete a list of merge request context commits.

DELETE /projects/:id/merge_requests/:merge_request_iid/context_commits

Parameters:

AttributeTypeRequiredDescription
commitsstring arrayYesThe context commits’ SHA.
idintegerYesThe ID or URL-encoded path of the project.
merge_request_iidintegerYesThe internal ID of the merge request.