Adding a new optional property to the request/response body is considered backward incompatible.

Aperta
  • Qualcosa non va?
#264 5 commenti 0 reazioni 0 assegnatari Vedi su GitHub

Nessuno ha ancora preso questa issue.

Valutazione

Difficoltà
4/5
Tempo stimato
3-5 giorni
Idoneità per principianti
25/100
Tipo di issue
Bug
Chiarezza
Da chiarire
Stato di attività
Ferma
Stack tecnologico
java
Ambito
api

Direzione di ricerca

Inizia riproducendo il report di compatibilità con due specifiche OpenAPI minime: una con il body originale della richiesta/risposta e una che aggiunge una proprietà facoltativa con un valore predefinito. Traccia il modo in cui lo strumento di diff classifica questa modifica alla richiesta e alla risposta, quindi conferma il risultato rispetto al comportamento previsto di compatibilità all’indietro descritto nell’issue.

Scritto dal modello di indicizzazione a partire dal testo della issue.

Descrizione

Breaking/Non-Breaking classification

Hi,
Why adding a new optional property (with default value) is considered to be an incompatible change?

  • V1 client sends a request without a new field - then the default value will be used by the V2 server - [OK]
  • V1 client receives the response from the V2 server with a new field - it will simply be ignored by the V1 client - [OK]

I really do not see why the diff tool reports it as an incompatible change?

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.