OpenAPITools / OpenAPITools/openapi-diff
Support for detecting changes in webhooks
オープン
まだ誰も着手していません。
OpenAP 3.1.0 Support
- 主要言語
- Java
- スター
- 1.1k
- フォーク
- 190
- PR マージ指標
- 30日以内にマージされた PR はありません
説明
It would be nice to support API changes in webhooks defined with OpenAPI 3.1, in particular:
- Detect if a webhook is removed
- Detect changes in the webhook payload
Unfortunately it looks like now this is not possible.
This can be reproduced by doing:
String oldSpec = Paths.get("webhook1.yml").toUri().toString();
String newSpec = Paths.get("webhook2.yml").toUri().toString();
ChangedOpenApi diff = OpenApiCompare.fromLocations(oldSpec, newSpec);
The content of boths specs are attached here (as .txt but they are .yml specs)
Note that no differences are found in this case
コントリビューションガイド
はじめの一歩
- issue を最後まで読み、次にプロジェクトのコントリビューションガイドを読みます。
- 着手することを issue にコメントします — 二人が同じ作業をするのを防げます。
- リポジトリをフォークし、ブランチを切って変更します。
- issue 番号を参照したプルリクエストを送ります。
調査の方向性
まず、添付された webhook1.txt と webhook2.txt の仕様を使用して OpenApiCompare.fromLocations の再現を実行します。OpenAPI 3.1 の webhook がどのように比較されるかを追跡し、その後、webhook の削除と payload の変更が差分として報告されることを確認します。提供された仕様に対して両方のケースで差分が生成されれば完了です。
索引モデルが issue の本文から書いたものです。
評価
- 技術スタック
- java, openapi
- 領域
- api
- issue の種類
- 機能追加
- 難易度
- 4/5
- 見積もり時間
- 3〜5日
- 活発さ
- 停滞
- 明瞭さ
- おおむね明確
- 初心者へのやさしさ
- 42/100