OpenAPITools/openapi-diff

Version identifiers in paths

Open

#253 opened on Jul 28, 2021

View on GitHub
 (3 comments) (1 reaction) (0 assignees)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!

Contributor guide

Tech stack
javarest api
Domain
backendapitooling
Issue type
feature
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
3
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-2 days
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
stale
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
clear
Prerequisites
JavaOpenAPI specificationbasic knowledge of diff algorithms
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
45
Research direction
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.