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

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

Direzione di ricerca

Inizia individuando la definizione OpenAPI per #/paths/1repos1{owner}~1{repo}~1keys/get e l'esempio referenziato #/components/examples/deploy-key-items/value. Confronta la struttura dell'array dello schema con la struttura dell'elemento dell'esempio; il lavoro è completato quando lo schema e l'esempio sono coerenti.

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/deploy-key-items/value

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

Here's a snippet

>   1: {
    2:   "enabled" : [ {
    3:     "id" : 1,
    4:     "key" : "ssh-rsa AAA...",
    5:     "url" : "https://api.github.com/repos/octocat/Hello-World/keys/1",

Expected

The schema and example are in sync

Reproduction Steps

I could reproduce this in

  • ghes-3.14
  • ghes-3.15
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.