Version identifiers in paths

Open
#253 3 comments 1 reaction 0 assignees View on GitHub

Maintainers usually reply within 5 days

Nobody has claimed this yet.

Assessment

Difficulty
5/5
Estimated time
Over a week
Newbie friendliness
25/100
Issue type
Feature
Clarity
Needs clarification
Activity status
Stale
Tech stack
java
Domain
api

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.

Description

enhancement help wanted

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!

Dominant language
Java
Stars
1.1k
Forks
191
Avg merge
4d 23h
Merged PRs (30d)
1

Getting set up

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

More from OpenAPITools/openapi-diff

All issues in OpenAPITools/openapi-diff

Similar issues

More Java issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.