KnpLabs / KnpLabs/php-github-api

Invalid url for get reference endpoint?

Đang mở
#1,037 0 bình luận 0 reaction 0 người được giao Xem trên GitHub
Ngôn ngữ chính
PHP
Star
2.2k
Fork
587
Chỉ số merge pull request
Không có pull request nào được merge trong 30 ngày

Mô tả

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.

Hướng dẫn đóng góp

Chưa lập chỉ mục được hướng dẫn đóng góp cho kho mã nguồn này

Hướng nghiên cứu

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.

Do mô hình lập chỉ mục viết ra từ nội dung của issue.

Đánh giá

Công nghệ
github, php
Lĩnh vực
api
Loại issue
Lỗi
Độ khó
2/5
Thời gian dự kiến
1-3 giờ
Mức độ hoạt động
Đình trệ
Độ rõ ràng
Khá rõ ràng
Mức phù hợp với người mới
48/100

Nhận issue mới trong hộp thư của bạn

Bản tóm tắt ngắn những issue GitHub phù hợp với người mới.