Skip to content

Conversation

Copy link
Contributor

Copilot AI commented Aug 7, 2025

This PR documents the breaking change introduced in .NET 10 Preview 7 where the Microsoft.Extensions.ApiDescription.Client NuGet package has been deprecated.

Changes Made

  • Created breaking change document: Added /docs/core/compatibility/aspnet-core/10.0/apidescription-client-deprecated.md following the official template
  • Updated TOC: Added ASP.NET Core section to the .NET 10 breaking changes table of contents
  • Updated index: Added entry to the 10.0.md breaking changes overview page

Document Content

The breaking change document includes:

  • Version introduced: .NET 10 Preview 7
  • Type of change: Source incompatible
  • Previous behavior: Projects could use <PackageReference Include="Microsoft.Extensions.ApiDescription.Client" /> with <OpenApiReference> items
  • New behavior: Package is deprecated and generates build warnings
  • Migration guidance: Replace with generator-specific tooling (NSwag, Kiota, OpenAPI Generator)
  • Affected APIs: Lists the deprecated package, MSBuild items, and CLI commands

The documentation follows Microsoft's writing style guidelines and provides clear migration instructions for developers affected by this change.

Fixes #47447.


💬 Share your feedback on Copilot coding agent for the chance to win a $200 gift card! Click here to start the survey.


Internal previews

📄 File 🔗 Preview link
docs/core/compatibility/10.0.md Breaking changes in .NET 10
docs/core/compatibility/aspnet-core/10/apidescription-client-deprecated.md Microsoft.Extensions.ApiDescription.Client package deprecated
docs/core/compatibility/toc.yml docs/core/compatibility/toc

Copilot AI changed the title [WIP] Document https://github.com/aspnet/Announcements/issues/518 Document Microsoft.Extensions.ApiDescription.Client package deprecation breaking change Aug 7, 2025
Copilot AI requested a review from gewarren August 7, 2025 20:47
@dotnet-policy-service dotnet-policy-service bot added the okr-quality Content-quality KR: Concerns article defects (bugs), freshness, or build warnings. label Aug 7, 2025
@gewarren gewarren marked this pull request as ready for review August 7, 2025 21:45
@gewarren gewarren requested a review from a team as a code owner August 7, 2025 21:45
@gewarren gewarren requested a review from captainsafia August 7, 2025 21:45
Copy link
Member

@captainsafia captainsafia left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks good outside of one comment and cross-link for Microsoft.dotnet-openapi.

@gewarren gewarren requested a review from danroth27 August 8, 2025 18:14
@gewarren gewarren merged commit a9fff25 into main Aug 8, 2025
10 checks passed
@gewarren gewarren deleted the copilot/fix-47447 branch August 8, 2025 18:36
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

dotnet-fundamentals/svc okr-quality Content-quality KR: Concerns article defects (bugs), freshness, or build warnings.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Document https://github.com/aspnet/Announcements/issues/518

3 participants