OpenAPITools / OpenAPITools/openapi-diff

Wrong changelog generated when having objects with same field name

Aperta
#268 4 commenti 2 reazioni 0 assegnatari Vedi su GitHub

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

Lets say that the old and the new OpenAPI schemas have classes Object1 and Object2, both of which have a field myField1 without changes in-between the openapi schemas. If Obejct1.myField1 has different description than Object2.myField1, that would be detected as a change and printed in the output diff file.

Also, can you add some kind of configuration that would prevent the library to print such non-breaking changes (i.e. changed description is not a breaking change) ?

Guida per i contributori

Apri la guida per i contributori

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.

Direzione di ricerca

Riproduci il confronto con schemi OpenAPI vecchi e nuovi contenenti Object1.myField1 e Object2.myField1, in cui differiscono solo le descrizioni. Traccia il punto di ingresso della generazione del diff del changelog e verifica perché i campi vengono associati tra gli oggetti. Il lavoro è completato quando i campi invariati non producono più una modifica falsa e viene definito il comportamento di configurazione per sopprimere le modifiche alle descrizioni non incompatibili con le versioni precedenti.

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

Valutazione

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

Ricevi le nuove issue nella tua casella

Un breve riepilogo di issue GitHub adatte ai principianti.