OpenAPITools / OpenAPITools/openapi-diff

ExtensionDiff in renderers (just tried console and html)

Offen
#839 1 Kommentar 0 Reaktionen 0 zugewiesene Personen Auf GitHub ansehen

Dieses Issue hat noch niemand übernommen.

enhancement Render capabilities
Vorherrschende Sprache
Java
Sterne
1.1k
Forks
190
PR-Merge-Kennzahlen
Keine gemergten PRs in 30 T.

Beschreibung

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.

Beitragsleitfaden

Beitragsleitfaden öffnen

Erste Schritte

  1. Lies das ganze Issue und danach den Beitragsleitfaden des Projekts.
  2. Schreib ins Issue, dass du es übernimmst — das erspart doppelte Arbeit.
  3. Forke das Repository und arbeite in einem Branch.
  4. Öffne einen Pull Request, der die Issue-Nummer nennt.

Rechercherichtung

Beginne damit, ExtensionDiff vom Vergleichsergebnis bis zu den Konsolen- und HTML-Renderern nachzuverfolgen, wobei du dich auf das bestehende Rendering von Routenänderungen und Detail-Listen konzentrierst. Erledigt ist die Aufgabe, wenn beide Renderer Details zu Erweiterungsunterschieden anzeigen und angeben, ob diese Unterschiede Breaking oder Non-Breaking sind.

Vom Indexierungsmodell aus dem Issue-Text verfasst.

Bewertung

Tech-Stack
java
Bereich
api
Issue-Typ
Feature
Schwierigkeit
3/5
Geschätzter Aufwand
1-2 Tage
Aktivitätsstatus
Veraltet
Klarheit
Größtenteils klar
Anfängerfreundlichkeit
35/100

Neue Issues direkt in Ihr Postfach

Eine kurze Übersicht über anfängerfreundliche GitHub-Issues.