Compare two commits

Returns the changes between two points. The response from the API is equivalent to running the git log base...headcommand

Required scopes: WORKSPACE, REPOSITORY_READ

Resource URL

GET /workspaces/:domain/projects/:project_name/repository/comparison/:base...:head

URL Parameters

NameTypeDescription
base
Required		StringThe revision before the first one from the returned list.
domain
Required		StringThe workspace domain.
head
Required		StringThe last revision in the returned list.
project_name
Required		StringThe name ID of the project.

GET Parameters

NameTypeDescription
pageIntegerThe number of the successive page (results are splitted by pages of per_page elements each).
per_pageIntegerThe number of returned elements on the page.

Example

Request

GET https://api.buddy.works/workspaces/buddy/projects/company-website/repository/comparison/506a3963507943d6908154f4bc9646e829128a08...7c4786ffc65816bc3cd2418c3ceeb34134f4b03a

Sample Response

HTTP

Status: 200 OK
X-Rate-Limit-Limit: 1
X-Rate-Limit-Remaining: 999

JSON

{
  "url": "https://api.buddy.works/workspaces/buddy/projects/company-website/repository/comparison",
  "html_url": "https://app.buddy.works/buddy/company-website/repository/commits",
  "commits": [
    {
      "url": "https://api.buddy.works/workspaces/buddy/projects/company-website/repository/commits/7c4786ffc65816bc3cd2418c3ceeb34134f4b03a",
      "html_url": "https://app.buddy.works/buddy/company-website/repository/commit/7c4786ffc65816bc3cd2418c3ceeb34134f4b03a",
      "revision": "7c4786ffc65816bc3cd2418c3ceeb34134f4b03a",
      "author_date": "2016-03-02T12:29:55Z",
      "commit_date": "2016-03-02T12:29:55Z",
      "message": "Added readme.md",
      "committer": {
        "url": "https://api.buddy.works/workspaces/buddy/member/1",
        "html_url": "https://app.buddy.works/buddy/profile/1",
        "id": 1,
        "name": "Mike Benson",
        "avatar_url": "https://app.buddy.works/image-server/user/0/0/0/0/0/0/1/d643744fbe5ebf2906a4d075a5b97110/w/32/32/AVATAR.png",
        "title": "Creative director"
      },
      "author": {
        "url": "https://api.buddy.works/workspaces/buddy/member/1",
        "html_url": "https://app.buddy.works/buddy/profile/1",
        "id": 1,
        "name": "Mike Benson",
        "avatar_url": "https://app.buddy.works/image-server/user/0/0/0/0/0/0/1/d643744fbe5ebf2906a4d075a5b97110/w/32/32/AVATAR.png",
        "title": "Creative director"
      }
    }
  ],
  "base_commit": {
    "url": "https://api.buddy.works/workspaces/buddy/projects/company-website/repository/commits/506a3963507943d6908154f4bc9646e829128a08",
    "html_url": "https://app.buddy.works/buddy/company-website/repository/commit/506a3963507943d6908154f4bc9646e829128a08",
    "revision": "506a3963507943d6908154f4bc9646e829128a08",
    "author_date": "2016-01-19T12:36:33Z",
    "commit_date": "2016-01-19T12:36:33Z",
    "message": "init repo\n",
    "committer": {
      "url": "https://api.buddy.works/workspaces/buddy/member/1",
      "html_url": "https://app.buddy.works/buddy/profile/1",
      "id": 1,
      "name": "Mike Benson",
      "avatar_url": "https://app.buddy.works/image-server/user/0/0/0/0/0/0/1/d643744fbe5ebf2906a4d075a5b97110/w/32/32/AVATAR.png",
      "title": "Creative director"
    },
    "author": {
      "url": "https://api.buddy.works/workspaces/buddy/member/1",
      "html_url": "https://app.buddy.works/buddy/profile/1",
      "id": 1,
      "name": "Mike Benson",
      "avatar_url": "https://app.buddy.works/image-server/user/0/0/0/0/0/0/1/d643744fbe5ebf2906a4d075a5b97110/w/32/32/AVATAR.png",
      "title": "Creative director"
    }
  },
  "ahead": 0,
  "behind": 1
}
Questions?

Not sure how to configure a pipeline for your process? Reach out on the live-chat, contact support, or ask our community on our forum.

Sign up for Buddy Digest

Best practices on CI/CD and fresh changelogs delivered weekly to your inbox.