Skip to content

Conversation

Copy link
Contributor

Copilot AI commented Oct 27, 2025

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

  • Banner text: Replaced misleading statement with accurate explanation that Swashbuckle is no longer in default templates but remains available as a community package that can be manually added
  • Metadata: Updated ms.date to 10/27/2025 per repository guidelines

Files Modified

  • aspnetcore/tutorials/getting-started-with-swashbuckle/includes/getting-started-with-swashbuckle8.md
  • aspnetcore/tutorials/getting-started-with-swashbuckle.md

Fixes #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:

Swashbuckle is not available in .NET 9 or later. For an alternative, see Overview of OpenAPI support in ASP.NET Core API apps.

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:

  1. In .NET 9 and later, Microsoft’s official templates and docs use Microsoft.AspNetCore.OpenApi for built-in OpenAPI generation.
  2. Swashbuckle remains a community package that can be added manually if desired, but it isn’t part of the default template or the .NET 9+ documentation track.

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

  • ID: 14fce65f-1337-58cb-2193-8d8e0e62792d
  • PlatformId: 9d5054bd-d17f-09a2-cecc-b246950444f8
  • Service: aspnet-core
  • Sub-service: tutorials

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:

> [!NOTE]
> Swashbuckle is not available in .NET 9 or later. For an alternative, see <xref:fundamentals/openapi/overview?view=aspnetcore-9.0&preserve-view=true>.

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

  • The feedback is accurate and actionable.
  • The wording of the banner does not reflect the actual status of Swashbuckle in .NET 9+.
  • The scope is limited to the Swashbuckle tutorial and any related documentation referencing this banner.

Required Actions

1. File(s) to Change

  • aspnetcore/tutorials/getting-started-with-swashbuckle/includes/getting-started-with-swashbuckle8.md
  • (If the banner is reused elsewhere, those instances should also be updated.)

2. Recommended Revision

Replace the banner with more precise language. For example:

> [!NOTE]
> Starting with .NET 9, Microsoft’s official templates and documentation use the built-in `Microsoft.AspNetCore.OpenApi` package for OpenAPI support. Swashbuckle is no longer included by default, but remains available as a community package and can still be added manually to .NET 9+ projects. For more information, see <xref:fundamentals/openapi/overview?view=aspnetcore-9.0&preserve-view=true>.

3. Line Numbers

  • Change the first block (lines 1-3 in `getting-started-with-swashbuckle8.md...

💬 We'd love your input! Share your thoughts on Copilot coding agent in our 2 minute survey.


Internal previews

📄 File 🔗 Preview link
aspnetcore/tutorials/getting-started-with-swashbuckle.md Get started with Swashbuckle and ASP.NET Core

Co-authored-by: wadepickett <10985336+wadepickett@users.noreply.github.com>
Copilot AI changed the title [WIP] Fix misleading Swashbuckle notice in ASP.NET tutorial Clarify Swashbuckle availability in .NET 9+ banner Oct 27, 2025
Copilot AI requested a review from wadepickett October 27, 2025 18:58
Copilot finished work on behalf of wadepickett October 27, 2025 18:58
@wadepickett wadepickett marked this pull request as ready for review October 27, 2025 19:39
@wadepickett wadepickett requested a review from Copilot October 27, 2025 19:39
Copy link
Contributor

Copilot AI left a 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

@wadepickett wadepickett requested a review from Copilot October 27, 2025 20:21
Copy link
Contributor

Copilot AI left a 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.

Copy link
Contributor

@wadepickett wadepickett left a 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>
@wadepickett wadepickett requested a review from Copilot October 27, 2025 20:23
Copy link
Contributor

Copilot AI left a 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.

@wadepickett wadepickett requested a review from tdykstra October 27, 2025 20:23
Copy link
Contributor

@tdykstra tdykstra 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. One suggestion.

Updated note on OpenAPI support in .NET 9 and later, clarifying the status of Swashbuckle.
>
>The following instructions apply when using Swashbuckle with .NET versions earlier than 9.
There are three main components to Swashbuckle:
Copy link
Contributor

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.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Clarify “Swashbuckle is not available in .NET 9 or later” banner on the Swashbuckle tutorial

4 participants