microsoft / microsoft/OpenAPI.NET

Update SharpYaml dependency to v3.x

Ouverte
#3,014 2 commentaires 0 réactions 0 personnes assignées Voir sur GitHub

Personne n'a encore pris cette issue.

type:breaking-change
Langage dominant
C#
Étoiles
1.6k
Forks
286
Merge moyen
6 h 38 min
PR mergées (30 j)
35

Description

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.

Guide de contribution

Ouvrir le guide de contribution

Par où commencer

  1. Lisez l'issue en entier, puis le guide de contribution du projet.
  2. Signalez en commentaire que vous la prenez — cela évite que deux personnes fassent le même travail.
  3. Forkez le dépôt et travaillez sur une branche.
  4. Ouvrez une pull request qui référence le numéro de l'issue.

Piste de recherche

Localisez la déclaration de dépendance du projet pour SharpYaml v2 et examinez les breaking changes de SharpYaml v3 avant d’évaluer le traitement YAML d’OpenAPI concerné. Exécutez la suite de tests existante après la mise à jour de la dépendance ; c’est terminé lorsque SharpYaml v3 est utilisé et que le traitement YAML des documents OpenAPI reste compatible.

Rédigé par le modèle d'indexation à partir du texte de l'issue.

Évaluation

Stack technique
csharp, yaml
Domaine
api
Type d'issue
Fonctionnalité
Difficulté
4/5
Temps estimé
3-5 jours
Activité
Calme
Clarté
Plutôt claire
Accessibilité débutants
52/100

Recevez les nouvelles issues par e-mail

Un résumé court des issues GitHub adaptées aux débutants.