KnpLabs / KnpLabs/php-github-api

Invalid url for get reference endpoint?

Aberta
#1,037 0 comentários 0 reações 0 responsáveis Ver no GitHub
Linguagem predominante
PHP
Estrelas
2.2k
Forks
587
Métricas de merge de PRs
Nenhum PR com merge em 30d

Descrição

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.

Guia de contribuição

Nenhum guia de contribuição indexado para este repositório

Direção de pesquisa

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.

Escrita pelo modelo de indexação a partir do texto da issue.

Avaliação

Stack de tecnologia
github, php
Domínio
api
Tipo de issue
Bug
Dificuldade
2/5
Tempo estimado
1-3 horas
Status de atividade
Estagnada
Clareza
Razoavelmente clara
Facilidade para iniciantes
48/100

Receba novas issues na sua caixa de entrada

Um resumo curto de issues do GitHub para quem está começando.