OpenAPITools / OpenAPITools/openapi-diff

ExtensionDiff in renderers (just tried console and html)

Aperta
#839 1 commento 0 reazioni 0 assegnatari Vedi su GitHub

Nessuno ha ancora preso questa issue.

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

Descrizione

I'm implementing ExtensionDiffs, but it seems they don't make it into the renderers, or at least I don't see how they would.
I.e. I'm only using console and html.

The console renderer just lists the route as changed and says there were backward incompatible changes in the spec but no further detail.

The html renderer lists the route under "What's Changed" with an empty <ul> with class detail which then renders as a thick gray line.

It would be nice if the renderers would be able to display details about the extension differences, especially when they are breaking, but also the non-breaking ones would be interesting.

In the html renderer result there is not even an indication whether there were breaking changes or not if the breaking changes come from an extension diff.

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 tracciando ExtensionDiff dall’output del confronto fino ai renderer della console e HTML, concentrandoti sul rendering esistente delle modifiche alle route e degli elenchi di dettagli. Il lavoro è completato quando entrambi i renderer mostrano i dettagli delle differenze delle estensioni e indicano se tali differenze sono breaking o non-breaking.

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à
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.