OpenAPITools / OpenAPITools/openapi-diff
Renderers should display example changes, not just schema changes
Nessuno ha ancora preso questa issue.
- Lingua principale
- Java
- Stelle
- 1.1k
- Fork
- 190
- Metriche di merge delle PR
- Nessuna PR unita negli ultimi 30g
Descrizione
When a ChangedMediaType has example changes but no schema changes, the renderers (Console, Markdown, Asciidoc, HTML) currently show nothing in the details section because they only render schema changes. The ChangedMediaType model has example and examples fields that could be rendered alongside schema changes.
This was discovered while fixing https://github.com/OpenAPITools/openapi-diff/issues/870 where the NPE was caused by null schema when only examples changed.
Guida per i contributori
Apri la guida per i contributori
Come iniziare
- Leggi tutta la issue e poi la guida ai contributi del progetto.
- Commenta sulla issue per dire che te ne occupi tu — evita che due persone facciano lo stesso lavoro.
- Fai un fork del repository e lavora su un branch.
- Apri una pull request che faccia riferimento al numero della issue.
Direzione di ricerca
Inizia individuando il modello ChangedMediaType e i punti di ingresso dei renderer Console, Markdown, Asciidoc e HTML. Traccia come vengono aggiunte le modifiche allo schema alla sezione details, quindi verifica che anche le modifiche a example ed examples vengano gestite quando non esiste alcuna modifica allo schema. Conferma l’output di details per tutti e quattro i renderer e verifica la presenza di test di regressione esistenti.
Scritto dal modello di indicizzazione a partire dal testo della issue.
Valutazione
- Stack tecnologico
- java
- Ambito
- api
- Tipo di issue
- Bug
- Difficoltà
- 3/5
- Tempo stimato
- 1-2 giorni
- Stato di attività
- Ferma
- Chiarezza
- Abbastanza chiara
- Idoneità per principianti
- 48/100