OpenAPITools/openapi-diff

Version identifiers in paths

Open

#253 geöffnet am 28. Juli 2021

Auf GitHub ansehen
 (3 Kommentare) (1 Reaktion) (0 zugewiesene Personen)Java (1.079 Stars) (187 Forks)user submission
enhancementhelp wanted

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!

Contributor Guide

Tech Stack
javarest api
Domain
backendapitooling
Issue Type
feature
SchwierigkeitGeschätzte Implementierungsschwierigkeit für neue Contributors, von 1 für sehr kleine Änderungen bis 5 für Expertenarbeit.
3
Geschätzte ZeitEin grober Zeitrahmen, um zu recherchieren, zu implementieren, zu testen und einen Pull Request vorzubereiten.
1-2 days
AktivitätsstatusWie verfügbar das Issue gerade wirkt: frisch, aktiv, stale, blockiert oder wartet auf Maintainer-Input.
stale
KlarheitWie klar das Issue die erwartete Änderung, Akzeptanzkriterien und den nächsten Schritt erklärt.
clear
Voraussetzungen
JavaOpenAPI specificationbasic knowledge of diff algorithms
EinsteigerfreundlichkeitEin Score von 1 bis 100, der schätzt, wie zugänglich dieses Issue für First-Time Contributors ist.
45
Research-Richtung
Investigate the existing path comparison logic in the OpenAPI diff tool, likely in Java source files under src/main/java. Implement a wildcard matching strategy to ignore version segments in paths (e.g., replace /api/v{version}/ with a common pattern). Consider using regex or path templates to generalize the comparison. Check comments in this issue for additional context or suggestions.