Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

BREAKING CHANGE: Rename Microsoft.OpenApi.Readers to Microsoft.OpenApi.YamlReader #2166

Merged
merged 10 commits into from
Mar 18, 2025
Merged

BREAKING CHANGE: Rename Microsoft.OpenApi.Readers to Microsoft.OpenApi.YamlReader #2166

merged 10 commits into from
Mar 18, 2025

Conversation

MaggieKimani1
Copy link
Contributor

@MaggieKimani1 MaggieKimani1 commented Feb 25, 2025 •
edited
Loading

This PR aims to:

  • Rename the Microsoft.OpenApi.Readers to Microsoft.OpenApi.YamlReader for it to be more intuitive and align with the package's role.
  • This is in line with the breaking change involving migration of the loading code into the core lib to avoid clients having to take a dependency on an external YAML library.
  • Those working with YAML files will need to take a dependency on this new lib as Microsoft.OpenApi.Readers will become deprecated in v2.0.

Fixes #1957

@MaggieKimani1 MaggieKimani1 marked this pull request as ready for review March 17, 2025 12:55
@MaggieKimani1 MaggieKimani1 enabled auto-merge March 17, 2025 15:28
@sonarqubecloud SonarQubeCloud
Copy link

Quality Gate Failed Quality Gate failed

Failed conditions
68.3% Coverage on New Code (required ≥ 80%)

See analysis details on SonarQube Cloud

@MaggieKimani1 MaggieKimani1 merged commit b1428ca into main Mar 18, 2025
13 of 15 checks passed
@MaggieKimani1 MaggieKimani1 deleted the fix/rename-readers branch March 18, 2025 08:19
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@andrueastman andrueastman andrueastman approved these changes

@irvinesunday irvinesunday Awaiting requested review from irvinesunday

@darrelmiller darrelmiller Awaiting requested review from darrelmiller

@gavinbarron gavinbarron Awaiting requested review from gavinbarron

@millicentachieng millicentachieng Awaiting requested review from millicentachieng

@baywet baywet Awaiting requested review from baywet

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

[API review] Rename Microsoft.OpenAPI.readers to Microsoft.OpenAPI.YamlReader
2 participants
@MaggieKimani1 @andrueastman