Consider removal of deprecated elements as compatible

Offen

#371 erstellt am 05.5.2022 4 Kommentare 0 Reaktionen 0 zugewiesene Personen Auf GitHub ansehen

Dieses Issue hat noch niemand übernommen.

Bewertung

Schwierigkeit: 5/5
Geschätzter Aufwand: Über eine Woche
Anfängerfreundlichkeit: 20/100

Issue-Typ: Feature
Klarheit: Muss geklärt werden
Aktivitätsstatus: Veraltet
Tech-Stack: java
Bereich: api

Rechercherichtung

Beginnen Sie mit der Untersuchung von ChangedOpenApi#getChangedElements und wie openapi-diff das Entfernen derzeit als inkompatibel klassifiziert. Überprüfen Sie die vorhandenen Erweiterungspunkte und die im Issue vorgeschlagene SPI-Idee, bevor Sie sich für einen Ansatz entscheiden. Done sollte eine klare Möglichkeit bieten, das Entfernen veralteter Elemente als kompatibel zu behandeln und gleichzeitig die bestehenden Prüfungen auf Breaking Changes beizubehalten.

Vom Indexierungsmodell aus dem Issue-Text verfasst.

Beschreibung

Breaking/Non-Breaking classification

I'm using openapi-diff quite successfully to avoid accidental changes in the API (and therefore introducing a breaking change). We use it as a part of our pipeline.

The current struggle is: that sometimes one wants to introduce a breaking change (like the removal of obsolete API).
My initial idea would float around a two-step process:

marking an element ad deprecated (keeping compatibility)
removing the deprecated element

To do that, when processing the list of ChangedOpenApi#getChangedElements I'd need to know if the particular element is deprecatable and decide if the change is incompatible or not.

That looks to me like another SPI but I'm not sure if it's the direction. I know it's currently not possible and I'm not even sure if the direction of my thought even makes sense.

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

Beitragsleitfaden

Beitragsleitfaden öffnen

Erste Schritte

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

Mehr aus OpenAPITools/openapi-diff

In openapi-diff-cli add old and new filenames to the output Offen

enhancement

Schwierigkeit 2/5 1-3 Stunden Anfängerfreundlichkeit 68/100

OpenAPITools/openapi-diff#506 · Erstellt am 04.4.2023
HtmlRender: Notes of Parameters shows always the new description Offen

good first issue help wanted

Schwierigkeit 2/5 1-3 Stunden Anfängerfreundlichkeit 68/100

OpenAPITools/openapi-diff#364 · Erstellt am 05.4.2022
Property `type` change on referenced component schema is silently ignored Offen

bug OpenAP 3.1.0 Support

Schwierigkeit 3/5 1-2 Tage Anfängerfreundlichkeit 68/100

OpenAPITools/openapi-diff#910 · 1 Kommentar · Erstellt am 12.6.2026
Changes reported in operations but only securityScheme changed Offen

Render capabilities

Schwierigkeit 3/5 1-2 Tage Anfängerfreundlichkeit 55/100

OpenAPITools/openapi-diff#893 · 1 Kommentar · Erstellt am 25.2.2026
[Bug] Backward compatibility check fails on reordered discriminator mappings Offen

Breaking/Non-Breaking classification

Schwierigkeit 3/5 1-2 Tage Anfängerfreundlichkeit 55/100

OpenAPITools/openapi-diff#886 · Erstellt am 30.1.2026

Alle Issues in OpenAPITools/openapi-diff