OpenAPITools / OpenAPITools/openapi-diff

Version identifiers in paths

Offen
#253 3 Kommentare 1 Reaktion 0 zugewiesene Personen Auf GitHub ansehen

Dieses Issue hat noch niemand übernommen.

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

Beschreibung

The specs I want to compare have a version identifier in their paths:

E.g. api/v1/users and api/v2/users

Comparing these specs triggers false positives because of the paths, even when the rest of the specs are identical.

As a workaround I'm manipulating the specs before comparing - manually replacing api/v*/users with api/users in both.

Is there a way built into the tool that could solve my problem?

Or would it perhaps make sense to implement some kind of wildcard support?

Great project!

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, den Vergleich mit den beiden Beispielpfaden api/v1/users und api/v2/users zu reproduzieren, und überprüfe, wie Pfaddifferenzen gemeldet werden. Kläre, ob das beabsichtigte Ergebnis ein versionsunabhängiger Vergleich oder die Unterstützung von Wildcards ist; die fertige Lösung sollte das False Positive beseitigen und gleichzeitig aussagekräftige Pfaddifferenzen beibehalten.

Vom Indexierungsmodell aus dem Issue-Text verfasst.

Bewertung

Tech-Stack
java
Bereich
api
Issue-Typ
Feature
Schwierigkeit
5/5
Geschätzter Aufwand
Über eine Woche
Aktivitätsstatus
Veraltet
Klarheit
Muss geklärt werden
Anfängerfreundlichkeit
25/100

Neue Issues direkt in Ihr Postfach

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