microsoft / microsoft/OpenAPI.NET

Update SharpYaml dependency to v3.x

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

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

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

説明

Is your feature request related to a problem? Please describe.

OpenAPI.NET currently depends on SharpYaml v2. In my project, I use OpenAPI.NET to process OpenAPI documents and also need to read additional YAML-based configuration files.

SharpYaml v3 is a major redesign that introduces breaking changes compared to v2. Since OpenAPI.NET brings SharpYaml v2 as a dependency, I am currently forced to continue developing against the older SharpYaml API and plan a future migration.

Describe the solution you'd like

I would like OpenAPI.NET to update its SharpYaml dependency from v2 to the latest v3 release.

Describe alternatives you've considered

  • Continuing to use SharpYaml v2 in my own code and migrating later.
  • Isolating YAML processing behind an abstraction layer to minimize the impact of a future migration.
  • Using a different YAML library for application-specific configuration files.

While these approaches are possible, they add complexity that could be avoided if OpenAPI.NET adopted SharpYaml v3 directly.

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

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

はじめの一歩

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

調査の方向性

SharpYaml v2 のプロジェクト依存関係宣言を特定し、影響を受ける OpenAPI YAML 処理を評価する前に SharpYaml v3 の breaking changes を確認します。依存関係を更新した後、既存のテストスイートを実行します。完了の条件は、SharpYaml v3 が使用され、OpenAPI ドキュメントの YAML 処理の互換性が維持されていることです。

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

評価

技術スタック
csharp, yaml
領域
api
issue の種類
機能追加
難易度
4/5
見積もり時間
3〜5日
活発さ
静か
明瞭さ
おおむね明確
初心者へのやさしさ
52/100

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

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