Add Web API Analyzers deprecation warnings for .NET 10+#37295
Merged
Conversation
- Add WARNING callout in analyzers.md after H1 (for >= aspnetcore-10.0) - Add WARNING callout in conventions.md after H1 (for >= aspnetcore-10.0) - Add WARNING callout in include-metadata10.md near 'enable Web API analyzers' link - Add WARNING callout in include-metadata.md (>= aspnetcore-11.0) near 'enable Web API analyzers' link - Update ms.date in analyzers.md and conventions.md Fixes #37193
Copilot
AI
changed the title
[WIP] Add warning for deprecated Web API analyzers in .NET 10
Add Web API Analyzers deprecation warnings for .NET 10+
Jun 25, 2026
wadepickett
reviewed
Jun 25, 2026
wadepickett
reviewed
Jun 25, 2026
wadepickett
reviewed
Jun 25, 2026
Contributor
|
@mikekistler & @tdykstra for review. |
wadepickett
approved these changes
Jun 25, 2026
mikekistler
approved these changes
Jun 25, 2026
mikekistler
left a comment
Contributor
There was a problem hiding this comment.
Looks great! 👍
Thank you!
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
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.
Fixes #37193
Update based on example suggested drafts by wadepickett in the issue.
Web API Analyzers (
IncludeOpenAPIAnalyzersMSBuild property and associated MVC API analyzers) were deprecated in .NET 10 and will be removed in a future release, but the relevant docs had no indication of this.Changes
web-api/advanced/analyzers.md— Added[!WARNING]callout after H1, moniker-gated to>= aspnetcore-10.0. MentionsASPDEPR007build warning and recommends migrating toTypedResults.web-api/advanced/conventions.md— Same treatment; conventions rely on these analyzers.fundamentals/openapi/includes/include-metadata10.md— Added[!WARNING]after the "enable Web API analyzers" link. File is already scoped to= aspnetcore-10.0, so no additional moniker guard needed.fundamentals/openapi/include-metadata.md— Added[!WARNING]after the same link inside the existing>= aspnetcore-11.0moniker range.include-metadata9.mdis intentionally unchanged — deprecation does not apply to .NET 9.Example of the warning added to
analyzers.md:Internal previews