OpenAPITools / OpenAPITools/openapi-diff

Version identifiers in paths

オープン
#253 コメント 3 件 リアクション 1 件 担当者 0 名 GitHub で見る

まだ誰も着手していません。

enhancement help wanted
主要言語
Java
スター
1.1k
フォーク
190
PR マージ指標
30日以内にマージされた PR はありません

説明

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!

コントリビューションガイド

コントリビューションガイドを開く

はじめの一歩

  1. issue を最後まで読み、次にプロジェクトのコントリビューションガイドを読みます。
  2. 着手することを issue にコメントします — 二人が同じ作業をするのを防げます。
  3. リポジトリをフォークし、ブランチを切って変更します。
  4. issue 番号を参照したプルリクエストを送ります。

調査の方向性

まず、api/v1/users と api/v2/users という 2 つの例のパスで比較を再現し、パスの違いがどのように報告されるかを確認します。意図した結果がバージョンに依存しない比較なのか、ワイルドカードのサポートなのかを明確にします。完了時には、意味のあるパスの違いを維持しながら false positive を解消する必要があります。

索引モデルが issue の本文から書いたものです。

評価

技術スタック
java
領域
api
issue の種類
機能追加
難易度
5/5
見積もり時間
1週間以上
活発さ
停滞
明瞭さ
説明が足りない
初心者へのやさしさ
25/100

新しい issue をメールで受け取る

初心者向けの GitHub issue を短くまとめたダイジェスト。