microsoft / microsoft/OpenAPI.NET

Update SharpYaml dependency to v3.x

Offen
#3,014 2 Kommentare 0 Reaktionen 0 zugewiesene Personen Auf GitHub ansehen

Dieses Issue hat noch niemand übernommen.

type:breaking-change
Vorherrschende Sprache
C#
Sterne
1.6k
Forks
286
Ø Merge
6 Std. 38 Min.
Gemergte PRs (30 T.)
35

Beschreibung

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.

Beitragsleitfaden

Beitragsleitfaden öffnen

Erste Schritte

  1. Lies das ganze Issue und danach den Beitragsleitfaden des Projekts.
  2. Schreib ins Issue, dass du es übernimmst — das erspart doppelte Arbeit.
  3. Forke das Repository und arbeite in einem Branch.
  4. Öffne einen Pull Request, der die Issue-Nummer nennt.

Rechercherichtung

Finde die Abhängigkeitserklärung des Projekts für SharpYaml v2 und prüfe die Breaking Changes von SharpYaml v3, bevor du die betroffene OpenAPI-YAML-Verarbeitung bewertest. Führe nach der Aktualisierung der Abhängigkeit die vorhandene Testsuite aus; abgeschlossen bedeutet, dass SharpYaml v3 verwendet wird und die Verarbeitung von OpenAPI-Dokumenten im YAML-Format kompatibel bleibt.

Vom Indexierungsmodell aus dem Issue-Text verfasst.

Bewertung

Tech-Stack
csharp, yaml
Bereich
api
Issue-Typ
Feature
Schwierigkeit
4/5
Geschätzter Aufwand
3-5 Tage
Aktivitätsstatus
Ruhig
Klarheit
Größtenteils klar
Anfängerfreundlichkeit
52/100

Neue Issues direkt in Ihr Postfach

Eine kurze Übersicht über anfängerfreundliche GitHub-Issues.