OpenAPITools / OpenAPITools/openapi-diff
No backward compatible changes in Schema are marked as Compatible
Dieses Issue hat noch niemand übernommen.
- Vorherrschende Sprache
- Java
- Sterne
- 1.1k
- Forks
- 190
- PR-Merge-Kennzahlen
- Keine gemergten PRs in 30 T.
Beschreibung
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.
Beitragsleitfaden
Erste Schritte
- Lies das ganze Issue und danach den Beitragsleitfaden des Projekts.
- Schreib ins Issue, dass du es übernimmst — das erspart doppelte Arbeit.
- Forke das Repository und arbeite in einem Branch.
- Öffne einen Pull Request, der die Issue-Nummer nennt.
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.
Bewertung
- Tech-Stack
- java
- Bereich
- api
- Issue-Typ
- Bug
- Schwierigkeit
- 4/5
- Geschätzter Aufwand
- 3-5 Tage
- Aktivitätsstatus
- Veraltet
- Klarheit
- Größtenteils klar
- Anfängerfreundlichkeit
- 35/100