OpenAPITools / OpenAPITools/openapi-diff
False positive breaking change when making a required request body optional
Nessuno ha ancora preso questa issue.
- Lingua principale
- Java
- Stelle
- 1.1k
- Fork
- 190
- Metriche di merge delle PR
- Nessuna PR unita negli ultimi 30g
Descrizione
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 :)
Guida per i contributori
Apri la guida per i contributori
Come iniziare
- Leggi tutta la issue e poi la guida ai contributi del progetto.
- Commenta sulla issue per dire che te ne occupi tu — evita che due persone facciano lo stesso lavoro.
- Fai un fork del repository e lavora su un branch.
- Apri una pull request che faccia riferimento al numero della issue.
Direzione di ricerca
Inizia creando o individuando una coppia di specifiche OpenAPI in cui il request body di un'operazione passa da obbligatorio a facoltativo, quindi esegui il confronto che segnala le breaking changes. Segui il risultato di compatibilità per questa modifica al request body ed esamina i test vicini. Il lavoro è completato quando la modifica non viene più segnalata come incompatibile, mentre le altre incompatibilità del request body continuano a essere rilevate.
Scritto dal modello di indicizzazione a partire dal testo della issue.
Valutazione
- Stack tecnologico
- java, openapi
- Ambito
- api, backend-api-design
- Tipo di issue
- Bug
- Difficoltà
- 3/5
- Tempo stimato
- 1-2 giorni
- Stato di attività
- Ferma
- Chiarezza
- Abbastanza chiara
- Idoneità per principianti
- 38/100