Show additions / changes to schema body

Offen
#207 4 Kommentare 4 Reaktionen 0 zugewiesene Personen Auf GitHub ansehen

Dieses Issue hat noch niemand übernommen.

Bewertung

Schwierigkeit
3/5
Geschätzter Aufwand
1-2 Tage
Anfängerfreundlichkeit
48/100
Issue-Typ
Feature
Klarheit
Größtenteils klar
Aktivitätsstatus
Ruhig
Tech-Stack
java
Bereich
api

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.

Beschreibung

enhancement

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)

image

Vorherrschende Sprache
Java
Sterne
1.1k
Forks
191
PR-Merge-Kennzahlen
Keine gemergten PRs in 30 T.

Entwicklungsumgebung

Erste Schritte

  1. Lesen Sie das ganze Issue und danach den Beitragsleitfaden des Projekts.
  2. Schreiben Sie ins Issue, dass Sie es übernehmen — das erspart doppelte Arbeit.
  3. Forken Sie das Repository und arbeiten Sie in einem Branch.
  4. Öffnen Sie einen Pull Request, der die Issue-Nummer nennt.

Mehr aus OpenAPITools/openapi-diff

Alle Issues in OpenAPITools/openapi-diff

Ähnliche Issues

Weitere Issues zu Java

Neue Issues direkt in Ihr Postfach

Eine kurze Übersicht über anfängerfreundliche GitHub-Issues.