OpenAPITools / OpenAPITools/openapi-diff
Version identifiers in paths
Nobody has claimed this yet.
- Dominant language
- Java
- Stars
- 1.1k
- Forks
- 190
- 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
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start by reproducing the comparison with the two example paths, api/v1/users and api/v2/users, and review how path differences are reported. Clarify whether the intended result is version-insensitive comparison or wildcard support; done should eliminate the false positive while preserving meaningful path differences.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- java
- Domain
- api
- Issue type
- Feature
- Difficulty
- 5/5
- Estimated time
- Over a week
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 25/100