php-github-api icon indicating copy to clipboard operation
php-github-api copied to clipboard

Invalid url for get reference endpoint?

Open vovayatsyuk opened this issue 4 years ago • 0 comments

While this code works fine for most use cases:

https://github.com/KnpLabs/php-github-api/blob/de2f27846139e7b4b92dcad9ff77660d0dc5dfad/lib/Github/Api/GitData/References.php#L83

It looks like that GET /refs/{ref} is an undocumented endpoint and it returns an array of references when an exact reference is not found, but other similar references are found in the repo.

Current GitHub docs tells to use GET /ref/{ref} URL: https://docs.github.com/en/rest/reference/git#get-a-reference

My story: I have the following references in the repo:

  • accepted-1-1
  • accepted-1-1-1

When I try to get accepted-1 reference using references()->show(..) I get the following response, but I expect zero results:

Screenshot 2021-11-11 at 22 15 41

If I change GET /refs/{ref} to GET /ref/{ref} in References.php it starts throwing a 404 not found exception as expected.

vovayatsyuk avatar Nov 11 '21 20:11 vovayatsyuk