Commit¶

A commit is the unit of a repository's version history. With the API you can list and read commits, compare two references, get the diff and patch, view code contribution statistics, and post comments on commits.

Objects¶

Identification¶

• A repository is identified by owner + repo; a commit is identified by sha or ref (branch name, tag name, etc.).
• A comparison uses the ellipsis form {base}...{head} in the path.
• A comment is identified by id; to query comments for a commit, use sha or ref.

Common tasks¶

Notes¶

• The commit itself uses the plural /commits/{sha}, while diff and patch use the singular /commit/{sha}/diff (/patch); the two path families coexist.
• The code contribution statistics path is missing the repos/ segment: GET /api/v5/{owner}/{repo}/repository/commit_statistics, which differs from how the other endpoints are formed.
• Comments have three entry points: per commit /commits/{sha}/comments (write), per ref /commits/{ref}/comments (read), and all comments in the repository /comments (read); reading, updating, and deleting a single comment all go through /comments/{id}.
• The comparison endpoint path must be written as {base}...{head} (three dots), not a slash or two dots.

Endpoint list¶

This module contains 12 endpoints in total.