False positive breaking change when making a required request body optional

Aperta
  • Qualcosa non va?
#329 0 commenti 6 reazioni 0 assegnatari Vedi su GitHub

Nessuno ha ancora preso questa issue.

Valutazione

Difficoltà
3/5
Tempo stimato
1-2 giorni
Idoneità per principianti
38/100
Tipo di issue
Bug
Chiarezza
Abbastanza chiara
Stato di attività
Ferma
Stack tecnologico
java, openapi
Ambito
api, backend-api-design

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.

Descrizione

Breaking/Non-Breaking classification

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 :)

Lingua principale
Java
Stelle
1.1k
Fork
191
Nessuna PR unita negli ultimi 30g

Preparare l'ambiente

Come iniziare

  1. Leggi tutta la issue e poi la guida ai contributi del progetto.
  2. Commenta sulla issue per dire che te ne occupi tu — evita che due persone facciano lo stesso lavoro.
  3. Fai un fork del repository e lavora su un branch.
  4. Apri una pull request che faccia riferimento al numero della issue.

Altre issue di OpenAPITools/openapi-diff

Tutte le issue di OpenAPITools/openapi-diff

Issue simili

Altre issue su Java

Ricevi le nuove issue nella tua casella

Un breve riepilogo di issue GitHub adatte ai principianti.