OpenAPITools / OpenAPITools/openapi-diff
PUT new attribute backwards compatibility 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
https://github.com/OpenAPITools/openapi-diff/issues/136 made the PUT request incompatibility check stricter, considering an additional field as a breaking change. This makes sense for a scenario where updates are taking place, but is too strict if PUTs represent only inserts.
What would be the best way of optionally removing the strict handling of PUTs? Options could include:
- Surfacing more information about how the
changedOperation.isIncompatible()decision was made, allowing the user of the OpenApiDiff to use more granular information to decide whether it should be considered as a breaking change. - Adding a command-line flag to remove the PUT strictness for all cases in a run.
- Writing some code to traverse the object graph for PUTs when the diff has completed and decide whether the strict PUT handling is what caused the incompatibility, and then ignore 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 tracciando il modo in cui changedOperation.isIncompatible() gestisce i campi aggiunti nelle richieste PUT e come tale risultato raggiunge il diff completato. Confronta gli approcci proposti: esporre informazioni granulari sull'incompatibilità, aggiungere un flag da riga di comando oppure attraversare il grafo degli oggetti dopo il diff. Il lavoro è completato quando è stato specificato un unico design scelto e ne è stato descritto il comportamento per i PUT che eseguono solo inserimenti e per i PUT in stile aggiornamento.
Scritto dal modello di indicizzazione a partire dal testo della issue.
Valutazione
- Stack tecnologico
- java
- Ambito
- api
- Tipo di issue
- Funzionalità
- Difficoltà
- 5/5
- Tempo stimato
- Più di una settimana
- Stato di attività
- Ferma
- Chiarezza
- Da chiarire
- Idoneità per principianti
- 30/100