Deprecate WithOpenApi extension methods with ASPDEPR002 diagnostic code #62779
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Co-authored-by: captainsafia <1857993+captainsafia@users.noreply.github.com>
| @@ -1,6 +1,7 @@ | |||
| #if (GenerateApi) | |||
| using System.Net.Http; | |||
| #endif | |||
| #pragma warning disable ASPDEPR002 // WithOpenApi is deprecated | |||
There was a problem hiding this comment.
@copilot Instead of #pragma warning disable here, remove the .WithOpenApi call in this template.
There was a problem hiding this comment.
Removed the .WithOpenApi() call from the template and the pragma warning disable directive. Templates should not include deprecated methods. f0200ea
WithOpenApi extension methods
Copilot finished work on behalf of
captainsafia
July 17, 2025 16:24
Co-authored-by: captainsafia <1857993+captainsafia@users.noreply.github.com>
martincostello
approved these changes
Jul 17, 2025
captainsafia
approved these changes
Jul 17, 2025
| @@ -29,6 +29,7 @@ public static class OpenApiEndpointConventionBuilderExtensions | |||
| /// </remarks> | |||
| /// <param name="builder">The <see cref="IEndpointConventionBuilder"/>.</param> | |||
| /// <returns>A <see cref="IEndpointConventionBuilder"/> that can be used to further customize the endpoint.</returns> | |||
| [Obsolete("WithOpenApi is deprecated and will be removed in a future release. For more information, visit https://aka.ms/aspnet/deprecate/002.", DiagnosticId = "ASPDEPR002")] | |||
There was a problem hiding this comment.
Should this warning or the linked page mention using MapOpenApi?
BrennanConroy
approved these changes
Jul 17, 2025
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This PR deprecates the
WithOpenApiextension methods inMicrosoft.AspNetCore.OpenApiwith diagnostic codeASPDEPR002, as outlined in the issue discussion.Changes Made
1. Added Obsolete Attributes
Added
[Obsolete]attributes withDiagnosticId = "ASPDEPR002"to bothWithOpenApimethod overloads:WithOpenApi<TBuilder>(this TBuilder builder)WithOpenApi<TBuilder>(this TBuilder builder, Func<OpenApiOperation, OpenApiOperation> configureOperation)Obsoletion message:
2. Warning Suppression
Added
#pragma warning disable ASPDEPR002directives to files that legitimately use these deprecated methods:OpenApiRouteHandlerBuilderExtensionTests.csProgram.MinimalAPIs.OrgOrIndividualB2CAuth.cs3. Verification
Confirmed that:
ASPDEPR002diagnosticExample Warning Output
When developers use these methods without suppressing warnings, they will see:
Migration Path
Users should migrate from
WithOpenApi()to either:Microsoft.AspNetCore.OpenApiOperationFilterfeature supported by Swashbuckle.AspNetCoreFixes #62778.
💬 Share your feedback on Copilot coding agent for the chance to win a $200 gift card! Click here to start the survey.