[Schema Inaccuracy] /orgs/{org}/dependabot/alerts schema is missing 'page'

Aperta Adatta ai principianti

#4,350 aperta il 2/12/2024 2 commenti 0 reazioni 0 assegnatari Vedi su GitHub

Nessuno ha ancora preso questa issue.

Valutazione

Difficoltà: 2/5
Tempo stimato: 1-3 ore
Idoneità per principianti: 68/100

Tipo di issue: Bug
Chiarezza: Specificata chiaramente
Stato di attività: Ferma
Stack tecnologico: openapi
Ambito: api

Direzione di ricerca

Inizia individuando lo schema OpenAPI per GET /orgs/{org}/dependabot/alerts e confronta i relativi parametri con la documentazione di Dependabot collegata e con gli altri endpoint degli avvisi dell’organizzazione. Aggiungi il parametro page mancante e verifica che lo schema corrisponda ai link di paginazione dell’endpoint e supporti i client generati che utilizzano page.

Scritto dal modello di indicizzazione a partire dal testo della issue.

Descrizione

documentation

Schema Inaccuracy

The API endpoint to get dependabot alerts for an org/enterprise do not contain the page parameter.

When calling these endpoints, the returned links for rel=next etc. include the page parameter. Using the page parameter in subsequent requests works like expected, therefore the schema seems to be inconsistent with the implementation here.

https://docs.github.com/en/rest/dependabot/alerts?apiVersion=2022-11-28#list-dependabot-alerts-for-an-organization

Other Organizational Alert Endpoints (Secret Scanning etc.) have the page parameter specified in the schema.

Expected

The schema should include the page parameter for the endpoint.

Reproduction Steps

Call Endpoint
Response data returns links with the page set in the links section.

As I am using an lib that is auto generated from the schemas this creates issues as it tries to use a value for page on an object that does not know 'page'.

Thanks :)

Lingua principale: Nessun dato sulla lingua
Stelle: 1.6k
Fork: 342
Merge medio: 2h 23m
PR unite (30g): 57

Guida per i contributori

Apri la guida per i contributori

Come iniziare

Leggi tutta la issue e poi la guida ai contributi del progetto.
Commenta sulla issue per dire che te ne occupi tu — evita che due persone facciano lo stesso lavoro.
Fai un fork del repository e lavora su un branch.
Apri una pull request che faccia riferimento al numero della issue.