OpenAPITools / OpenAPITools/openapi-diff
Show additions / changes to schema body
Dieses Issue hat noch niemand übernommen.
- Vorherrschende Sprache
- Java
- Sterne
- 1.1k
- Forks
- 190
- PR-Merge-Kennzahlen
- Keine gemergten PRs in 30 T.
Beschreibung
Is it possible to show non-breaking changes (i.e. added fields) to the schema body?
The current output simply states "changed body: 'application/json'"
If I reverse the comparison I get a message:
Changed body: 'application/json'
Missing property: [n].id (integer)
So a useful message would be:
Changed body: 'application/json'
Added property: [n].id (integer)
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, den in der Issue beschriebenen OpenAPI-Vergleich einschließlich des umgekehrten Vergleichs zu reproduzieren, und verfolge, wo Änderungen am Schema-Body formatiert werden. Aktualisiere den Reporting-Pfad so, dass hinzugefügte Eigenschaften von fehlenden Eigenschaften unterschieden werden, und überprüfe anschließend, dass die Ausgabe neben der Meldung zum geänderten Body einen Eintrag „Added property“ wie [n].id (integer) enthält.
Vom Indexierungsmodell aus dem Issue-Text verfasst.
Bewertung
- Tech-Stack
- java
- Bereich
- api
- Issue-Typ
- Feature
- Schwierigkeit
- 3/5
- Geschätzter Aufwand
- 1-2 Tage
- Aktivitätsstatus
- Ruhig
- Klarheit
- Größtenteils klar
- Anfängerfreundlichkeit
- 48/100