KnpLabs / KnpLabs/php-github-api

Invalid url for get reference endpoint?

未關閉
#1,037 0 則留言 0 個 reaction 已指派 0 人 在 GitHub 檢視
主要語言
PHP
星號
2.2k
分支
587
PR 合併指標
30 天內沒有已合併 PR

描述

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.

貢獻指南

這個儲存庫沒有索引到貢獻指南

研究方向

Start in lib/Github/Api/GitData/References.php at the referenced line and compare the requested path with GitHub's current get-a-reference documentation. Reproduce the lookup for a partial reference and verify that an exact missing reference no longer returns similarly named references; update the relevant behavior and add or adjust coverage where the repository's existing tests cover this endpoint.

由索引模型根據 Issue 內容生成。

評估

技術堆疊
github, php
領域
api
Issue 類型
缺陷
難度
2/5
預估耗時
1-3 小時
活躍度
停滯
描述清晰度
基本清楚
新手友好度
48/100

把新 issue 寄到你的電子郵件信箱

精選適合新手參與的 GitHub issue 摘要。