OpenAPITools / OpenAPITools/openapi-diff
Renderers should display example changes, not just schema changes
Dieses Issue hat noch niemand übernommen.
- Vorherrschende Sprache
- Java
- Sterne
- 1.1k
- Forks
- 190
- PR-Merge-Kennzahlen
- Keine gemergten PRs in 30 T.
Beschreibung
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.
Beitragsleitfaden
Erste Schritte
- Lies das ganze Issue und danach den Beitragsleitfaden des Projekts.
- Schreib ins Issue, dass du es übernimmst — das erspart doppelte Arbeit.
- Forke das Repository und arbeite in einem Branch.
- Öffne einen Pull Request, der die Issue-Nummer nennt.
Rechercherichtung
Beginne damit, das Modell ChangedMediaType und die Einstiegspunkte der Renderer Console, Markdown, Asciidoc und HTML zu lokalisieren. Verfolge, wie Schemaänderungen zum details-Abschnitt hinzugefügt werden, und überprüfe anschließend, dass Änderungen an example und examples ebenfalls verarbeitet werden, wenn keine Schemaänderung vorhanden ist. Bestätige die details-Ausgabe für alle vier Renderer und prüfe, ob bereits Regressionstests vorhanden sind.
Vom Indexierungsmodell aus dem Issue-Text verfasst.
Bewertung
- Tech-Stack
- java
- Bereich
- api
- Issue-Typ
- Bug
- Schwierigkeit
- 3/5
- Geschätzter Aufwand
- 1-2 Tage
- Aktivitätsstatus
- Veraltet
- Klarheit
- Größtenteils klar
- Anfängerfreundlichkeit
- 48/100