microsoft / microsoft/OpenAPI.NET

OpenApiComparer is not implemented

オープン
#414 コメント 9 件 リアクション 5 件 担当者 0 名 GitHub で見る

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

priority:p2 type:enhancement
主要言語
C#
スター
1.6k
フォーク
286
平均マージ
6時間 38分
マージ済み PR(30日)
35

説明

Hello,

My team is using this repository to generate our OpenAPI document, and we started using the OpenApiComparer recently in our project. This method returns a value so we believed it was working until recently when after making a change this still returned an empty list.

After looking at the implementation it's quite clear that this method does nothing but it is documented as being a method that "Compares two OpenApiDocuments and returns a list of differences.".

I believe this method should be removed or should throw instead.

After looking a bit more, there seems to be a valid implementation of this in the vnext branch that was never merged into master.

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

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

はじめの一歩

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

調査の方向性

まず src/Microsoft.OpenApi/Services/OpenApiComparer.cs を読み、vnext ブランチにある有効な実装を調査します。意図された解決策が、メソッドを削除すること、例外をスローさせること、または vnext の実装を取り込むことのいずれであるかを判断します。完了の条件は、比較に対して OpenApiComparer が空の結果を黙って返さなくなることです。

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

評価

技術スタック
csharp, openapi
領域
api
issue の種類
バグ
難易度
3/5
見積もり時間
1〜2日
活発さ
停滞
明瞭さ
おおむね明確
初心者へのやさしさ
35/100

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

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