GitLab REST API "get single repository branch" documentation does not describe return object

Everyone can contribute. Help move this issue forward while earning points, leveling up and collecting rewards.

• Close this issue

Problem to solve

The current version of the Gitlab REST API documentation (v13.9?) describes how to get information about a given branch. In addition to general branch properties, it returns a commit object.

What does this particular commit object represent? I cannot determine this from the current documentation; branches usually have many commits.

{
  "name": "master",
  "merged": false,
  "protected": true,
  "default": true,
  "developers_can_push": false,
  "developers_can_merge": false,
  "can_push": true,
  "web_url": "http://gitlab.example.com/my-group/my-project/-/tree/master",
  "commit": {
    "author_email": "john@example.com",
    "author_name": "John Smith",
    "authored_date": "2012-06-27T05:51:39-07:00",
    "committed_date": "2012-06-28T03:44:20-07:00",
    "committer_email": "john@example.com",
    "committer_name": "John Smith",
    "id": "7b5c3cc8be40ee161ae89a06bba6229da1032a0c",
    "short_id": "7b5c3cc",
    "title": "add projects API",
    "message": "add projects API",
    "parent_ids": [
      "4ad91d3c1144c406e50c7b33bae684bd6837faf8"
    ]
  }
}

Proposal

The documentation should be clear on what this commit object represents.

Who can address the issue

Anyone who knows what the commit object means in this context should be able to help here.

Other links/references

https://docs.gitlab.com/ee/api/branches.html#get-single-repository-branch