[Schema Inaccuracy] Example and schema mismatch for `#/paths/~1enterprises~1{enterprise}~1actions~1hosted-runners/get`

Aperta
#5,481 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
48/100
Tipo di issue
Bug
Chiarezza
Specificata chiaramente
Stato di attività
Ferma
Stack tecnologico
openapi
Ambito
api, documentation

Direzione di ricerca

Esamina l'esempio actions-hosted-runner-paginated e gli schemi degli endpoint GET e POST di enterprise hosted-runners. Confronta il campo image dell'esempio con il campo image_details dello schema, quindi verifica che l'esempio e entrambi gli schemi degli endpoint siano coerenti.

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/actions-hosted-runner-paginated/value

The field image doesn't exist in the schema, but exists in the example. It's probably meant to be image_details.

Here's a snippet

    3:     "id" : 5,
    4:     "name" : "My hosted ubuntu runner",
    5:     "runner_group_id" : 2,
    6:     "platform" : "linux-x64",
>   7:     "image" : {
    8:       "id" : "ubuntu-20.04",
    9:       "size" : 86
   10:     },
   11:     "machine_size_details" : {

Expected

The schema and example are in sync

Reproduction Steps

I could reproduce this in

  • ghec

Also happens in

#/paths/~1enterprises~1{enterprise}~1actions~1hosted-runners/post
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.