OpenAPITools / OpenAPITools/openapi-diff

Adding a new optional property to the request/response body is considered backward incompatible.

Offen
#264 5 Kommentare 0 Reaktionen 0 zugewiesene Personen Auf GitHub ansehen

Dieses Issue hat noch niemand übernommen.

Breaking/Non-Breaking classification
Vorherrschende Sprache
Java
Sterne
1.1k
Forks
190
PR-Merge-Kennzahlen
Keine gemergten PRs in 30 T.

Beschreibung

Hi,
Why adding a new optional property (with default value) is considered to be an incompatible change?

  • V1 client sends a request without a new field - then the default value will be used by the V2 server - [OK]
  • V1 client receives the response from the V2 server with a new field - it will simply be ignored by the V1 client - [OK]

I really do not see why the diff tool reports it as an incompatible change?

Beitragsleitfaden

Beitragsleitfaden öffnen

Erste Schritte

  1. Lies das ganze Issue und danach den Beitragsleitfaden des Projekts.
  2. Schreib ins Issue, dass du es übernimmst — das erspart doppelte Arbeit.
  3. Forke das Repository und arbeite in einem Branch.
  4. Öffne einen Pull Request, der die Issue-Nummer nennt.

Rechercherichtung

Beginne damit, den Kompatibilitätsbericht mit zwei minimalen OpenAPI-Spezifikationen zu reproduzieren: eine mit dem ursprünglichen Request-/Response-Body und eine, die eine optionale Property mit einem Standardwert hinzufügt. Verfolge, wie das Diff-Tool diese Änderung an Request und Response klassifiziert, und bestätige das Ergebnis anschließend anhand des im Issue beschriebenen erwarteten Verhaltens bezüglich der Abwärtskompatibilität.

Vom Indexierungsmodell aus dem Issue-Text verfasst.

Bewertung

Tech-Stack
java
Bereich
api
Issue-Typ
Bug
Schwierigkeit
4/5
Geschätzter Aufwand
3-5 Tage
Aktivitätsstatus
Veraltet
Klarheit
Muss geklärt werden
Anfängerfreundlichkeit
25/100

Neue Issues direkt in Ihr Postfach

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