- 
          
- 
                Notifications
    You must be signed in to change notification settings 
- Fork 1.3k
Update documentation for v10 and OpenAPI 3.1 #3585
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
Conversation
- 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 Report✅ All modified and coverable lines are covered by tests. 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           
 Flags with carried forward coverage won't be shown. Click here to find out more. ☔ View full report in Codecov by Sentry. 🚀 New features to boost your workflow:
 | 
Add the version of Microsoft.OpenApi included to the version table.
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.
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
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.
Uh oh!
There was an error while loading. Please reload this page.