OpenAPITools / OpenAPITools/openapi-diff

Show additions / changes to schema body

Aperta
#207 4 commenti 4 reazioni 0 assegnatari Vedi su GitHub

Nessuno ha ancora preso questa issue.

enhancement
Lingua principale
Java
Stelle
1.1k
Fork
190
Metriche di merge delle PR
Nessuna PR unita negli ultimi 30g

Descrizione

Is it possible to show non-breaking changes (i.e. added fields) to the schema body?
The current output simply states "changed body: 'application/json'"

If I reverse the comparison I get a message:
Changed body: 'application/json'
Missing property: [n].id (integer)

So a useful message would be:
Changed body: 'application/json'
Added property: [n].id (integer)

image

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

Inizia riproducendo il confronto OpenAPI descritto nella issue, incluso il confronto inverso, e segui il percorso fino al punto in cui vengono formattate le modifiche allo schema-body. Aggiorna il percorso di reporting in modo che le proprietà aggiunte siano distinte da quelle mancanti, quindi verifica che l’output includa una voce “Added property” come [n].id (integer) insieme al messaggio relativo al body modificato.

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

Valutazione

Stack tecnologico
java
Ambito
api
Tipo di issue
Funzionalità
Difficoltà
3/5
Tempo stimato
1-2 giorni
Stato di attività
Tranquilla
Chiarezza
Abbastanza chiara
Idoneità per principianti
48/100

Ricevi le nuove issue nella tua casella

Un breve riepilogo di issue GitHub adatte ai principianti.