microsoft / microsoft/OpenAPI.NET

Update SharpYaml dependency to v3.x

Aperta
#3,014 2 commenti 0 reazioni 0 assegnatari Vedi su GitHub

Nessuno ha ancora preso questa issue.

type:breaking-change
Lingua principale
C#
Stelle
1.6k
Fork
286
Merge medio
6h 38m
PR unite (30g)
35

Descrizione

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.

Guida per i contributori

Apri la guida per i contributori

Come iniziare

  1. Leggi tutta la issue e poi la guida ai contributi del progetto.
  2. Commenta sulla issue per dire che te ne occupi tu — evita che due persone facciano lo stesso lavoro.
  3. Fai un fork del repository e lavora su un branch.
  4. Apri una pull request che faccia riferimento al numero della issue.

Direzione di ricerca

Individua la dichiarazione delle dipendenze del progetto per SharpYaml v2 e rivedi le breaking changes di SharpYaml v3 prima di valutare l’elaborazione YAML di OpenAPI interessata. Esegui la suite di test esistente dopo l’aggiornamento della dipendenza; il lavoro è completato quando viene utilizzato SharpYaml v3 e la gestione YAML dei documenti OpenAPI rimane compatibile.

Scritto dal modello di indicizzazione a partire dal testo della issue.

Valutazione

Stack tecnologico
csharp, yaml
Ambito
api
Tipo di issue
Funzionalità
Difficoltà
4/5
Tempo stimato
3-5 giorni
Stato di attività
Tranquilla
Chiarezza
Abbastanza chiara
Idoneità per principianti
52/100

Ricevi le nuove issue nella tua casella

Un breve riepilogo di issue GitHub adatte ai principianti.