GitHub REST and GraphQL API are returning different data

Question

I am scraping some data from GitHub. The RESTful URL to this particular PR shows that it has a merge_commit_sha value: https://api.github.com/repos/ansible/ansible/pulls/15088

However, when I try to get the same PR using GitHub GraphQL API, it shows it does not have any mergedCommit value.

  resource(
    url: "https://github.com/ansible/ansible/pull/15088"
  ) { 
    ...on PullRequest {
      id
      number
      title
      merged
      mergeCommit {
        message
      }
    }
  }

For context, the PR of interest is actually merged and should have a merged-commit value. I am looking for an explanation of the difference between these two APIs.

score 0 · Answer 1 · answered Nov 10 '22 at 05:04

Feel like it is a bug to me because if you query another PR such as 45454 , it can return the mergeCommit:

{
  "data": {
    "resource": {
      "id": "MDExOlB1bGxSZXF1ZXN0MjE0NDYyOTY2",
      "number": 45454,
      "title": "win_say - fix up syntax and test issues (#45450)",
      "merged": true,
      "mergeCommit": {
        "message": "win_say - fix up syntax and test issues (#45450)\n\n\n(cherry picked from commit c9c141fb6a51d6b77274958a2340fa54754db692)",
        "oid": "f2d5954d11a1707cdb70b01dfb27c722b6416295"
      }
    }
  }
}

Also find out other encountered the same problem at this and another similar issue at this. I suggest you can try to raise this issue to them at this.

score 0 · Accepted Answer · answered Nov 14 '22 at 18:55

This link posted in the other answer contains the explanation:

As in, Git doesn’t have the originalCommit (which makes sense). Presumably the original commit SHA is there, but the graphQL API actually checks to see if git has it, whereas the REST API doesn’t?

If you search for the commit SHA the API returns, you can't find it in the repo.

https://github.com/ansible/ansible/commit/d7b54c103050d9fc4965e57b7611a70cb964ab25

Since this is a very old pull request on an active repo, there's a good chance some old commits were cleaned up or other maintenance on the repo. It's hard to tell as that kind of maintenance obviously isn't version controlled.

Another option is the pull request was merged with fast-forward, which does not involve a merge commit. But that wouldn't explain the SHA on the REST API response.

So probably at some point they removed old merge commits to save some space, or something similar. Some objects still point to removed SHAs, but GraphQL API filters on existing objects.

GitHub REST and GraphQL API are returning different data

2 Answers2