[Schema Inaccuracy] Example and schema mismatch for `#/paths/~1classrooms~1{classroom_id}/get`

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

Direzione di ricerca

Inizia con il riferimento al percorso interessato #/paths/1classrooms1{classroom_id}/get e con l'esempio in #/components/examples/classroom/value. Confronta il valore archiviato e la virgola finale, quindi verifica che lo schema e l'esempio siano sincronizzati per la risposta GET di classroom.

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/classroom/value

Schema and example mismatch. archived should be a boolean. The String representation has a trailing comma.

Here's a snippet

    1: {
>   2:   "archived" : "false,",
    3:   "id" : 1296269,
    4:   "name" : "Programming Elixir",
    5:   "organization" : {
    6:     "id" : 1,

Affected Schema Refs

#/paths/~1classrooms~1{classroom_id}/get

Expected

The schema and example are in sync

Reproduction Steps

I could reproduce this in

  • fpt
  • ghec
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.