Skip to content

Conversation

@martincostello
Copy link
Collaborator

@martincostello martincostello commented Sep 30, 2025

  • Update documentation for v10.
  • Add code snippets for all samples to validate compilation (not function).
  • Add migration guide from v9 to v10.

- Update the README for changes in v10.
- Update most references to Swagger to OpenAPI.
- Add skeleton for migration guide.
Update the documentation for `onfigure-and-customize-swagger.md` for v10.
Update the documentation for `configure-and-customize-swaggerui` for v10.
Update the documentation for `configure-and-customize-swaggergen` for v10.
Update the package README for v10.
Update the documentation for `configure-and-customize-cli` for v10.
Update the documentation for `configure-and-customize-redoc` for v10.
Update the documentation for `configure-and-customize-annotations` for v10.
Add a row to the README for v10.
@codecov
Copy link

codecov bot commented Sep 30, 2025

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 94.75%. Comparing base (6cad31d) to head (a64d7a9).
⚠️ Report is 1 commits behind head on dotnet-vnext.
✅ All tests successful. No failed tests found.

Additional details and impacted files
@@              Coverage Diff              @@
##           dotnet-vnext    #3585   +/-   ##
=============================================
  Coverage         94.75%   94.75%           
=============================================
  Files               110      110           
  Lines              3830     3830           
  Branches            759      759           
=============================================
  Hits               3629     3629           
  Misses              201      201           
Flag Coverage Δ
Linux 94.75% <ø> (ø)
Windows 94.75% <ø> (ø)
macOS ?

Flags with carried forward coverage won't be shown. Click here to find out more.

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:
  • 📦 JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.

Add the version of Microsoft.OpenApi included to the version table.
@martincostello martincostello mentioned this pull request Sep 30, 2025
13 tasks
Initial support for generating code snippets in the documentation from code that is checked to compile.
Add code snippets for README.
Add code snippets for SwaggerUI.
Add code snippets for the Redoc documentation.
Add code snippet for SwaggerHostFactory.
Add code snippets for annotations.
Add code snippets for Swagger documentation.
Add code snippets for SwaggerGen documentation.
Add initial migration guide for v10.
Remove un-needed section and update various bits and bobs.
@martincostello martincostello marked this pull request as ready for review October 1, 2025 09:37
Copilot AI review requested due to automatic review settings October 1, 2025 09:37
Copy link

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

Updates documentation for Swashbuckle.AspNetCore v10 and adds support for OpenAPI 3.1, including a comprehensive migration guide and code snippets for validation.

  • Updates all documentation to reflect v10 changes and OpenAPI 3.1 support
  • Adds extensive code snippets in a new test project for documentation validation
  • Creates migration guide explaining breaking changes from v9 to v10

Reviewed Changes

Copilot reviewed 43 out of 43 changed files in this pull request and generated 2 comments.

Show a summary per file
File Description
test/WebSites/DocumentationSnippets/ New test project with code snippets for documentation validation
docs/migrating-to-v10.md New migration guide from v9 to v10
docs/*.md Updated documentation files with code snippet references and v10 content
README.md Updated main documentation with v10 compatibility table and snippet integration
.github/workflows/update-documentation.yml New GitHub workflow for automated documentation updates
.config/dotnet-tools.json Added markdown snippets tool for documentation maintenance
mdsnippets.json Configuration for markdown snippets processing

Tip: Customize your code reviews with copilot-instructions.md. Create the file or learn how to get started.

Fix incorrect base branch name.
@martincostello martincostello merged commit 6ac8b2c into dotnet-vnext Oct 1, 2025
11 of 13 checks passed
@martincostello martincostello deleted the openapi-3.1-migration-guide branch October 1, 2025 10:07
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.

2 participants