[Schema Inaccuracy] Example and schema mismatch for `#/paths/~1installation~1repositories/get`

Aperta
#5,497 1 commento 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
Specificata chiaramente
Stato di attività
Ferma
Stack tecnologico
openapi
Ambito
api

Direzione di ricerca

Inizia confrontando lo schema di #/paths/1installation1repositories/get con l’esempio in #/components/examples/repository-paginated-2/value. Controlla come viene rappresentato template_repository in ciascuno, quindi aggiorna lo schema o l’esempio non corrispondente in modo che siano coerenti e verifica che la descrizione dell’endpoint rimanga valida.

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

Descrizione

content documentation

Schema Inaccuracy

This is the json ref for the example

#/components/examples/repository-paginated-2/value

The field template_repository doesn't exist in the schema, but exists in the example.

Here's a snippet

   91:     "pushed_at" : "2011-01-26T19:06:43Z",
   92:     "created_at" : "2011-01-26T19:01:12Z",
   93:     "updated_at" : "2011-01-26T19:14:43Z",
   94:     "allow_rebase_merge" : true,
>  95:     "template_repository" : null,
   96:     "temp_clone_token" : "ABTLWHOULUVAXGTRYU7OC2876QJ2O",
   97:     "allow_squash_merge" : true,
   98:     "allow_auto_merge" : false,
   99:     "delete_branch_on_merge" : true,

Expected

The schema and example are in sync

Reproduction Steps

I could reproduce this in

  • fpt
  • ghec
  • ghes-3.14
  • ghes-3.15
  • ghes-3.16
  • ghes-3.17
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.