-
Notifications
You must be signed in to change notification settings - Fork 25.1k
Clarify Swashbuckle availability in .NET 9+ banner #36273
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.
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
base: main
Are you sure you want to change the base?
Conversation
Co-authored-by: wadepickett <10985336+wadepickett@users.noreply.github.com>
...ore/tutorials/getting-started-with-swashbuckle/includes/getting-started-with-swashbuckle8.md
Outdated
Show resolved
Hide resolved
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Pull Request Overview
This PR clarifies the banner message about Swashbuckle availability in .NET 9+ on the Swashbuckle tutorial page. The original banner incorrectly implied that Swashbuckle cannot be used with .NET 9+, when it actually remains available as a community package but is no longer included in Microsoft's default templates.
Key Changes:
- Updated banner text to accurately explain that Swashbuckle is available but no longer in default .NET 9+ templates
- Added link to the Microsoft.AspNetCore.OpenApi NuGet package
- Updated metadata date to 10/27/2025
Reviewed Changes
Copilot reviewed 2 out of 2 changed files in this pull request and generated no comments.
| File | Description |
|---|---|
| aspnetcore/tutorials/getting-started-with-swashbuckle/includes/getting-started-with-swashbuckle8.md | Replaced misleading banner text with accurate explanation of Swashbuckle's status in .NET 9+ |
| aspnetcore/tutorials/getting-started-with-swashbuckle.md | Updated ms.date metadata to reflect the documentation update |
...ore/tutorials/getting-started-with-swashbuckle/includes/getting-started-with-swashbuckle8.md
Outdated
Show resolved
Hide resolved
...ore/tutorials/getting-started-with-swashbuckle/includes/getting-started-with-swashbuckle8.md
Outdated
Show resolved
Hide resolved
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Pull Request Overview
Copilot reviewed 2 out of 2 changed files in this pull request and generated 1 comment.
...ore/tutorials/getting-started-with-swashbuckle/includes/getting-started-with-swashbuckle8.md
Outdated
Show resolved
Hide resolved
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Approved with minor fix.
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Pull Request Overview
Copilot reviewed 2 out of 2 changed files in this pull request and generated no new comments.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Looks good. One suggestion.
...ore/tutorials/getting-started-with-swashbuckle/includes/getting-started-with-swashbuckle8.md
Outdated
Show resolved
Hide resolved
...ore/tutorials/getting-started-with-swashbuckle/includes/getting-started-with-swashbuckle8.md
Outdated
Show resolved
Hide resolved
Added 2nd link
Updated note on OpenAPI support in .NET 9 and later, clarifying the status of Swashbuckle.
...ore/tutorials/getting-started-with-swashbuckle/includes/getting-started-with-swashbuckle8.md
Show resolved
Hide resolved
...ore/tutorials/getting-started-with-swashbuckle/includes/getting-started-with-swashbuckle8.md
Outdated
Show resolved
Hide resolved
...ore/tutorials/getting-started-with-swashbuckle/includes/getting-started-with-swashbuckle8.md
Show resolved
Hide resolved
...ore/tutorials/getting-started-with-swashbuckle/includes/getting-started-with-swashbuckle8.md
Outdated
Show resolved
Hide resolved
...ore/tutorials/getting-started-with-swashbuckle/includes/getting-started-with-swashbuckle8.md
Outdated
Show resolved
Hide resolved
| > | ||
| >The following instructions apply when using Swashbuckle with .NET versions earlier than 9. | ||
| There are three main components to Swashbuckle: |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
The swashbuckle version (6.6.2) of the instructions is outdated (5/21/2024).
It could be updated to the latest version (9.0.6), which should not impact the code.
If you want I can upgrade the .NET 9/10 examples and update the version in the docs as well.
The current banner states "Swashbuckle is not available in .NET 9 or later," implying the package cannot be used. This is incorrect—Swashbuckle remains available as a community package; it's simply not included in Microsoft's official .NET 9+ templates.
Changes
ms.dateto 10/27/2025 per repository guidelinesFiles Modified
aspnetcore/tutorials/getting-started-with-swashbuckle/includes/getting-started-with-swashbuckle8.mdaspnetcore/tutorials/getting-started-with-swashbuckle.mdFixes #36272
Original prompt
This section details on the original issue you should resolve
<issue_title>Clarify “Swashbuckle is not available in .NET 9 or later” banner on the Swashbuckle tutorial</issue_title>
<issue_description>### Description
The ASP.NET 8 tutorial has a notice that reads:
The wording reads as if the Swashbuckle package cannot be used on .NET 9+, which is not accurate. The intent appears to be that Swashbuckle is no longer part of the official templates and isn’t covered by the .NET 9+ docs track, which now focuses on the built-in
Microsoft.AspNetCore.OpenApi. This is explained on the .NET 9 OpenAPI overview, but the tutorial banner doesn’t say this and can mislead readers who land directly on the page via search.In my opinion, the tutorial should clearly state that:
Microsoft.AspNetCore.OpenApifor built-in OpenAPI generation.Page URL
https://learn.microsoft.com/en-us/aspnet/core/tutorials/getting-started-with-swashbuckle?view=aspnetcore-8.0&utm_source=chatgpt.com&tabs=visual-studio
Content source URL
https://github.com/dotnet/AspNetCore.Docs/blob/main/aspnetcore/tutorials/getting-started-with-swashbuckle.md
Document ID
59222460-a971-e76e-4fe9-23d4d7d768ee
Platform Id
9d5054bd-d17f-09a2-cecc-b246950444f8
Article author
@wadepickett
Metadata
Related Issues</issue_description>
Comments on the Issue (you are @copilot in this section)
@wadepickett @msiemens, thanks for taking the time to call this out. Very appreciated. We will get it udpated. @wadepickett AI analysis test run by wadepickett Prompt: verify-issue-set-course-of-action_v.03.md Model: GPT-4 Oct-2025 -------Issue Analysis: Swashbuckle Banner Clarity in .NET 9+ Documentation
Issue Summary
This is a valid issue.
Review
Published Article:
ASP.NET Core: Getting Started with Swashbuckle
Content Source:
getting-started-with-swashbuckle.md
Includes:
get-started-with-swashbuckle8.md
Current Banner Text:
Located in
aspnetcore/tutorials/getting-started-with-swashbuckle/includes/getting-started-with-swashbuckle8.md:This text appears in the published article for ASP.NET 8.
Issue Description:
The issue points out that the current banner could mislead readers. The wording implies Swashbuckle cannot be used at all in .NET 9+, when the actual change is that Swashbuckle is no longer included in official templates or documentation. Swashbuckle remains available as a community package for manual addition.
Validity & Scope
Required Actions
1. File(s) to Change
aspnetcore/tutorials/getting-started-with-swashbuckle/includes/getting-started-with-swashbuckle8.md2. Recommended Revision
Replace the banner with more precise language. For example:
3. Line Numbers
💬 We'd love your input! Share your thoughts on Copilot coding agent in our 2 minute survey.
Internal previews