OpenAPITools / OpenAPITools/openapi-diff

Add documentation for detectable breaking/non-breaking changes

Offen
#138 1 Kommentar 6 Reaktionen 0 zugewiesene Personen Auf GitHub ansehen

Dieses Issue hat noch niemand übernommen.

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

Beschreibung

We are using this library to power a GitHub Action that generates a backward compatibility report between two versions of an OpenAPI spec. We love this library, but it is not clear what changes are detectable by this library, and what changes this library classifies as "breaking" or "non-breaking" changes. It would be really valuable to us if this repo could include a markdown file outlining all the OAS changes that this library can detect.

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

Es ist keine Datei oder kein Test benannt. Beginne damit, das OpenAPI-Vergleichsverhalten der Bibliothek zu überprüfen und zu erfassen, welche Spezifikationsänderungen sie erkennt und wie sie diese als Breaking oder Non-Breaking klassifiziert. Als abgeschlossen gilt die Aufgabe, wenn ein Markdown-Dokument hinzugefügt wurde, das die erkennbaren OAS-Änderungen und ihre Klassifizierungen klar darlegt.

Vom Indexierungsmodell aus dem Issue-Text verfasst.

Bewertung

Tech-Stack
java
Bereich
api, documentation
Issue-Typ
Dokumentation
Schwierigkeit
4/5
Geschätzter Aufwand
3-5 Tage
Aktivitätsstatus
Veraltet
Klarheit
Größtenteils klar
Anfängerfreundlichkeit
45/100

Neue Issues direkt in Ihr Postfach

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