OpenAPITools/openapi-diff

Version identifiers in paths

Open

#253 opened on Jul 28, 2021

View on GitHub
 (3 comments) (1 reaction) (0 assignees)Java (187 forks)user submission
enhancementhelp wanted

Repository metrics

Stars
 (1,079 stars)
PR merge metrics
 (No merged PRs in 30d)

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

Research direction
Examine how openapi diff matches paths between two specs. Identify where version identifiers (e.g., v1, v2) cause false positives. Consider adding an option to ignore or normalize version prefixes in path comparison.
Tech stack
java
Domain
api
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.
Half day
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Active
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
JavaGit
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
60