OpenAPITools / OpenAPITools/openapi-diff
Wrong changelog generated when having objects with same field name
Dieses Issue hat noch niemand übernommen.
- Vorherrschende Sprache
- Java
- Sterne
- 1.1k
- Forks
- 190
- PR-Merge-Kennzahlen
- Keine gemergten PRs in 30 T.
Beschreibung
Lets say that the old and the new OpenAPI schemas have classes Object1 and Object2, both of which have a field myField1 without changes in-between the openapi schemas. If Obejct1.myField1 has different description than Object2.myField1, that would be detected as a change and printed in the output diff file.
Also, can you add some kind of configuration that would prevent the library to print such non-breaking changes (i.e. changed description is not a breaking change) ?
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
Vergleiche alte und neue OpenAPI-Schemas mit Object1.myField1 und Object2.myField1, bei denen sich nur die Beschreibungen unterscheiden. Verfolge den Einstiegspunkt der Changelog-Diff-Generierung und überprüfe, warum die Felder objektübergreifend zugeordnet werden. Als erledigt gilt die Aufgabe, wenn unveränderte Felder keine falsche Änderung mehr erzeugen und das Konfigurationsverhalten zum Unterdrücken nicht abwärtskompatibilitätsbrechender Beschreibungsänderungen definiert ist.
Vom Indexierungsmodell aus dem Issue-Text verfasst.
Bewertung
- Tech-Stack
- java, openapi
- Bereich
- api
- Issue-Typ
- Bug
- Schwierigkeit
- 4/5
- Geschätzter Aufwand
- 3-5 Tage
- Aktivitätsstatus
- Veraltet
- Klarheit
- Größtenteils klar
- Anfängerfreundlichkeit
- 35/100