Skip to main content
Manja / GitHub
Schema1.1.4object

commit-comparison

Commit Comparison

Source
github-v3-rest.json
Revision
f5f067c1e6f6
Active snapshot
85e53e3d0d65

Commit Comparison

object

Commit Comparison

ahead_by integer
required

Example:4

base_commit Commit object
required
behind_by integer
required

Example:5

commits array
required
diff_url string (uri)
required

Example:https://github.com/octocat/Hello-World/compare/master...topic.diff

files array
optional
html_url string (uri)
required

Example:https://github.com/octocat/Hello-World/compare/master...topic

merge_base_commit Commit object
required
patch_url string (uri)
required

Example:https://github.com/octocat/Hello-World/compare/master...topic.patch

permalink_url string (uri)
required

Example:https://github.com/octocat/Hello-World/compare/octocat:bbcd538c8e72b8c175046e27cc8f907076331401...octocat:0328041d1152db8ae77652d1618a02e57f745f17

status string
required

Example:ahead

Allowed: "diverged""ahead""behind""identical"

total_commits integer
required

Example:6

url string (uri)
required

Example:https://api.github.com/repos/octocat/Hello-World/compare/master...topic