Skip to content

Conversation

Copy link
Contributor

Copilot AI commented Aug 7, 2025

This PR documents the breaking change announced in aspnet/Announcements#519 where the WithOpenApi extension methods in Microsoft.AspNetCore.OpenApi.OpenApiEndpointConventionBuilderExtensions have been deprecated in .NET 10 Preview 7.

Breaking Change Summary

  • Type: Behavioral change (new compiler warning ASPDEPR002)
  • Version: .NET 10 Preview 7
  • Impact: Calls to .WithOpenApi() now produce deprecation warnings
  • Reason: Duplicated functionality, simplifying API surface
  • Migration: Remove .WithOpenApi() calls and use AddOpenApiOperationTransformer instead

Changes Made

  1. Created new breaking change document at docs/core/compatibility/aspnet-core/10.0/withopenapi-deprecated.md following the established template
  2. Added ASP.NET Core section to docs/core/compatibility/10.0.md with the new breaking change entry
  3. Updated TOC at docs/core/compatibility/toc.yml to include the new document

The document includes:

  • Clear description of the behavioral change
  • Code examples showing before/after behavior
  • Migration guidance with updated code samples
  • Proper cross-references and formatting

All changes have been validated with markdownlint and follow the repository's documentation standards.

Fixes #47448.


💬 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/withopenapi-deprecated.md Deprecation of WithOpenApi extension method
docs/core/compatibility/toc.yml docs/core/compatibility/toc

Copilot AI changed the title [WIP] Document https://github.com/aspnet/Announcements/issues/519 Document .NET 10 Preview 7 breaking change: Deprecation of WithOpenApi extension method Aug 7, 2025
Copilot AI requested a review from gewarren August 7, 2025 20:52
@gewarren gewarren marked this pull request as ready for review August 7, 2025 22:04
@gewarren gewarren requested a review from a team as a code owner August 7, 2025 22:04
@gewarren gewarren requested a review from captainsafia August 7, 2025 22:47
@gewarren gewarren requested a review from danroth27 August 8, 2025 18:13
@gewarren gewarren enabled auto-merge (squash) August 8, 2025 18:54
@gewarren gewarren merged commit 4a965d2 into main Aug 8, 2025
10 checks passed
@gewarren gewarren deleted the copilot/fix-47448 branch August 8, 2025 18:56
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

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

3 participants