[Schema Inaccuracy] Example and schema mismatch for `#/paths/~1repos~1{owner}~1{repo}~1dependabot~1alerts/get`

Aperta
#5,628 0 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
52/100
Tipo di issue
Bug
Chiarezza
Abbastanza chiara
Stato di attività
Ferma
Stack tecnologico
openapi
Ambito
api

Direzione di ricerca

Inizia individuando le definizioni OpenAPI per i due percorsi GET degli alert Dependabot e l’esempio referenziato dependabot-alerts-for-repository. Confronta l’elemento dello schema epss con l’array di esempio, quindi verifica che entrambi gli schemi dei percorsi e gli esempi siano sincronizzati nelle descrizioni API interessate.

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

Descrizione

feature

Schema Inaccuracy

This is the json ref for the example

#/components/examples/dependabot-alerts-for-repository/value

Schema and example mismatch. The schema has an element. The example has an array.

Here's a snippet

   49:         "vector_string" : "CVSS:4.0/AV:N/AC:L/AT:N/PR:N/UI:N/VC:H/VI:N/VA:N/SC:N/SI:N/SA:N",
   50:         "score" : 8.7
   51:       }
   52:     },
>  53:     "epss" : [ {
   54:       "percentage" : 4.5E-4,
   55:       "percentile" : "0.16001e0"
   56:     } ],
   57:     "cwes" : [ {

Same problem found in

#/paths/~1repos~1{owner}~1{repo}~1dependabot~1alerts~1{alert_number}/get

Expected

The schema and example are in sync

Reproduction Steps

I could reproduce this in

  • fpt
  • ghec
  • ghes-3.16
  • ghes-3.17
  • ghes-3.18
Lingua principale
Nessun dato sulla lingua
Stelle
1.6k
Fork
342
Merge medio
3h 33m
PR unite (30g)
51

Guida per i contributori

Apri la guida per i contributori

Come iniziare

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

Altre issue di github/rest-api-description

Tutte le issue di github/rest-api-description

Issue simili

Altre issue su Backend & API Design

Ricevi le nuove issue nella tua casella

Un breve riepilogo di issue GitHub adatte ai principianti.