OpenAPITools / OpenAPITools/openapi-diff
incompatible api diff result when one of property in model becomes not required
Offen
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 in new api version some property is not required anymore, new api is recognized as not compatible
old api schema definition:
"SomeDto": {
"required": [
"prop1",
"prop2",
"prop3"
], ...
new api schema definition:
"SomeDto": {
"required": [
"prop1"
], ...
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
Beginne damit, den Vergleich mit den im Issue gezeigten alten und neuen Schema-Definitionen zu reproduzieren, und verfolge dann, wo Änderungen an Pflicht-Eigenschaften als inkompatibel klassifiziert werden. Abgeschlossen ist die Aufgabe, wenn der Diff korrekt damit umgeht, dass eine Eigenschaft optional wird, und ein Regressionstest die Beispiel-Schemas abdeckt.
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