OpenAPITools / OpenAPITools/openapi-diff

In openapi-diff-cli add old and new filenames to the output

Offen Anfängerfreundlich
#506 0 Kommentare 0 Reaktionen 0 zugewiesene Personen Auf GitHub ansehen

Dieses Issue hat noch niemand übernommen.

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

Beschreibung

When using openapi-diff-cli we need to give and filenames.
It will be cool to have those filenames in the report output.

Before:

==========================================================================
==                            API CHANGE LOG                            ==
==========================================================================
                           API Name API
--------------------------------------------------------------------------
--                            What's Changed                            --
--------------------------------------------------------------------------
...

After:

==========================================================================
==                            API CHANGE LOG                            ==
==========================================================================
                           API Name API
--------------------------------------------------------------------------
old file: xxx.json
new file: yyy.json
--------------------------------------------------------------------------
--                            What's Changed                            --
--------------------------------------------------------------------------
...

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 am Einstiegspunkt für die Ausgabe des openapi-diff-cli-Reports und verfolge, wie die Dateinamen der alten und neuen Eingaben an die Reporterstellung übergeben werden. Führe die CLI mit den alten und neuen JSON-Eingaben des Issues aus und überprüfe anschließend, dass der Report beide Dateinamen im angezeigten Abschnitt enthält, ohne das bestehende Änderungsprotokoll zu ändern.

Vom Indexierungsmodell aus dem Issue-Text verfasst.

Bewertung

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

Neue Issues direkt in Ihr Postfach

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