Update SharpYaml dependency to v3.x

Open
#3,014 2 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Assessment

Difficulty
4/5
Estimated time
3-5 days
Newbie friendliness
52/100
Issue type
Feature
Clarity
Mostly clear
Activity status
Quiet
Tech stack
csharp, yaml
Domain
api

Research direction

Locate the project dependency declaration for SharpYaml v2 and review the SharpYaml v3 breaking changes before assessing affected OpenAPI YAML processing. Run the existing test suite after the dependency update; done means SharpYaml v3 is used and OpenAPI document YAML handling remains compatible.

Written by the indexing model from the issue text.

Description

type:breaking-change

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.

Dominant language
C#
Stars
1.6k
Forks
286
Avg merge
6h 38m
Merged PRs (30d)
35

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

More from microsoft/OpenAPI.NET

All issues in microsoft/OpenAPI.NET

Similar issues

More C# issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.