OpenAPITools/openapi-diff

Version identifiers in paths

Open

#253 ouverte le 28 juil. 2021

Voir sur GitHub
 (3 commentaires) (1 réaction) (0 assignés)Java (1 079 stars) (187 forks)user submission
enhancementhelp wanted

Description

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!

Guide contributeur

Stack technique
javarest api
Domaine
backendapitooling
Type d'issue
feature
DifficultéDifficulté estimée pour un nouveau contributeur, de 1 pour un très petit changement à 5 pour un travail expert.
3
Temps estiméFourchette de temps approximative pour investiguer, implémenter, tester et préparer une pull request.
1-2 days
Statut d'activitéDisponibilité apparente de l'issue : fraîche, active, ancienne, bloquée ou en attente d'un mainteneur.
stale
ClartéClarté avec laquelle l'issue explique le changement attendu, les critères d'acceptation et la prochaine étape.
clear
Prérequis
JavaOpenAPI specificationbasic knowledge of diff algorithms
Accessibilité débutantScore de 1 à 100 estimant l'accessibilité de cette issue pour un premier contributeur.
45
Direction de recherche
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.