OpenAPITools / OpenAPITools/openapi-diff

False positive breaking change when making a required request body optional

Offen
#329 0 Kommentare 6 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

If the request body of an operation changes from required to optional, the change will be detected as an incompatible change.

I argue that this is a false positive, because existing clients are still able to communicate as before.

If this issue is accepted, I would be happy to contribute a PR to fix it :)

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, ein Paar OpenAPI-Spezifikationen zu erstellen oder zu finden, bei denen sich der Request-Body einer Operation von erforderlich zu optional ändert, und führe dann den Vergleich aus, der Breaking Changes meldet. Verfolge das Kompatibilitätsergebnis für diese Änderung am Request-Body und sieh dir die benachbarten Tests an. Die Aufgabe ist abgeschlossen, wenn die Änderung nicht mehr als inkompatibel gemeldet wird, während andere Inkompatibilitäten des Request-Bodys weiterhin erkannt werden.

Vom Indexierungsmodell aus dem Issue-Text verfasst.

Bewertung

Tech-Stack
java, openapi
Bereich
api, backend-api-design
Issue-Typ
Bug
Schwierigkeit
3/5
Geschätzter Aufwand
1-2 Tage
Aktivitätsstatus
Veraltet
Klarheit
Größtenteils klar
Anfängerfreundlichkeit
38/100

Neue Issues direkt in Ihr Postfach

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