No backward compatible changes in Schema are marked as Compatible

Offen

#611 erstellt am 16.1.2024 0 Kommentare 4 Reaktionen 0 zugewiesene Personen Auf GitHub ansehen

Dieses Issue hat noch niemand übernommen.

Bewertung

Schwierigkeit: 4/5
Geschätzter Aufwand: 3-5 Tage
Anfängerfreundlichkeit: 35/100

Issue-Typ: Bug
Klarheit: Größtenteils klar
Aktivitätsstatus: Veraltet
Tech-Stack: java
Bereich: api

Rechercherichtung

Reproduziere die gemeldeten Vergleiche mit openapi-diff-core 2.1.0-beta.8, mit Fokus auf dem Entfernen von Schemaeigenschaften und Änderungen an Attributbeschreibungen. Verfolge die Prüfungen der Schema-Kompatibilität; abgeschlossen ist die Aufgabe, wenn entfernte Modellattribute als nicht kompatibel gemeldet werden und ausschließlich Beschreibungen betreffende Änderungen als Metadatenänderungen statt als kompatibel klassifiziert werden.

Vom Indexierungsmodell aus dem Issue-Text verfasst.

Beschreibung

Breaking/Non-Breaking classification

Hello, Thanks alot for this great library. I am testing this library and found the following bugs when comparing Schemas,

Library version: 'org.openapitools.openapidiff:openapi-diff-core:2.1.0-beta.8'

Removing an attribute from a Model is a non-backward compatible change, but It is marked as COMPATIBLE.
Updating description of an attribute is a Metadata change but this is also marked as COMPATIBLE

After several tests, I deduced, The current version is able to detect any change in schema models, but all changes are marked as COMPATIBLE. I think the compatibility checks including metadata change checks are missing.

Please have a look and provide a roadmap when this feature can be fixed. Thanks alot for all the effort and excellent work.

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