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

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

Direzione di ricerca

Individua l’esempio #/components/examples/environments/value a cui fa riferimento l’issue ed esamina il valore deployment_branch_policy.custom_branch_policies insieme al relativo schema. Correggi l’esempio in modo che il valore corrisponda al tipo booleano dichiarato, quindi verifica che lo schema e l’esempio siano sincronizzati per la risposta GET di environments.

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

Descrizione

Schema Inaccuracy

This is the json ref for the example

#/components/examples/environments/value

Schema and example mismatch. The expected type is boolean, but the value is "trues".

Here's a snippet

   62:       "type" : "branch_policy"
   63:     } ],
   64:     "deployment_branch_policy" : {
   65:       "protected_branches" : false,
>  66:       "custom_branch_policies" : "trues"
   67:     }
   68:   } ],
   69:   "total_count" : 1
   70: }

Expected

The schema and example are in sync

Reproduction Steps

I could reproduce this in

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