-
Notifications
You must be signed in to change notification settings - Fork 1.3k
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
Add NuGet package READMEs #2808
Add NuGet package READMEs #2808
Conversation
martincostello
commented
Apr 16, 2024
- Add a simple common README file for all NuGet packages.
- Cherry-pick changes from Change links to https in README #2715 to update README links from HTTP to HTTPS.
Add a simple common README file for all NuGet packages.
Update HTTP links to HTTPS. Co-Authored-By: Julian Verdurmen <5808377+304notmodified@users.noreply.github.com>
|
||
Generate beautiful API documentation, including a UI to explore and test operations, directly from your routes, controllers and models. | ||
|
||
[![Build status](https://github.com/domaindrivendev/Swashbuckle.AspNetCore/actions/workflows/build.yml/badge.svg?branch=master&event=push)](https://github.com/domaindrivendev/Swashbuckle.AspNetCore/actions?query=workflow%3Abuild+branch%3Amaster+event%3Apush) [![Code coverage](https://codecov.io/gh/domaindrivendev/Swashbuckle.AspNetCore/branch/master/graph/badge.svg)](https://codecov.io/gh/domaindrivendev/Swashbuckle.AspNetCore) |
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.
What is the added value to add Build status and Code coverage badges to the package readme of the master branch?
When I look for a package and see the readme, I don't need to know if the master branch failed to build. It could be interesting to know what the code coverage is for the specific package version, but it wouldn't influence my decision to use a package very much (except perhaps if the coverage is 0%...)
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.
Just because it's already in the README and it still renders correctly in NuGet's Content Security Policy. I've essentially kept the "top" of the repo README, but with everything their CSP policy forbids, such as the OpenSSF Scorecard badge.
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 coverage also wouldn't be "a" version. It would just be "now". Aligning that as burned-in content in the package is too much engineering effort.
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 coverage also wouldn't be "a" version. It would just be "now". Aligning that as burned-in content in the package is too much engineering effort.
Possibly it might be done using the /tags/{versionnumber} url, but indeed the effort doesn't really warrant that change.
Anyways, I just wanted to raise the question of the necessity for these badges in the package readme.
[![Mend Renovate](https://app.renovatebot.com/images/banner.svg)](https://renovatebot.com) This PR contains the following updates: | Package | Change | Age | Adoption | Passing | Confidence | |---|---|---|---|---|---| | [Swashbuckle.AspNetCore](https://togithub.com/domaindrivendev/Swashbuckle.AspNetCore) | `6.5.0` -> `6.6.1` | [![age](https://developer.mend.io/api/mc/badges/age/nuget/Swashbuckle.AspNetCore/6.6.1?slim=true)](https://docs.renovatebot.com/merge-confidence/) | [![adoption](https://developer.mend.io/api/mc/badges/adoption/nuget/Swashbuckle.AspNetCore/6.6.1?slim=true)](https://docs.renovatebot.com/merge-confidence/) | [![passing](https://developer.mend.io/api/mc/badges/compatibility/nuget/Swashbuckle.AspNetCore/6.5.0/6.6.1?slim=true)](https://docs.renovatebot.com/merge-confidence/) | [![confidence](https://developer.mend.io/api/mc/badges/confidence/nuget/Swashbuckle.AspNetCore/6.5.0/6.6.1?slim=true)](https://docs.renovatebot.com/merge-confidence/) | --- ### Release Notes <details> <summary>domaindrivendev/Swashbuckle.AspNetCore (Swashbuckle.AspNetCore)</summary> ### [`v6.6.1`](https://togithub.com/domaindrivendev/Swashbuckle.AspNetCore/releases/tag/v6.6.1) ##### What's Changed - Modernise build and migrate to GitHub Actions for CI by [@​martincostello](https://togithub.com/martincostello) in [domaindrivendev/Swashbuckle.AspNetCore#2775 - Update Redoc spelling in docs by [@​Quppa](https://togithub.com/Quppa) in [domaindrivendev/Swashbuckle.AspNetCore#2568 - C# 9 Record - Read example/summary from positional record by [@​pixellos](https://togithub.com/pixellos) in [domaindrivendev/Swashbuckle.AspNetCore#2546 - Grammatical correction of some comments by [@​mokarchi](https://togithub.com/mokarchi) in [domaindrivendev/Swashbuckle.AspNetCore#2768 - Update README.md for nested types custom schemaId support by [@​antmeehan](https://togithub.com/antmeehan) in [domaindrivendev/Swashbuckle.AspNetCore#2746 - Add support for `WithSummary` and `WithDescription` metadata by [@​hwoodiwiss](https://togithub.com/hwoodiwiss) in [domaindrivendev/Swashbuckle.AspNetCore#2414 - Update README.md - Fix `Add Security Definitions and Requirements for Bearer auth` URL by [@​Saibamen](https://togithub.com/Saibamen) in [domaindrivendev/Swashbuckle.AspNetCore#2705 - Replace <see href="link">text</see> with Markdown link format by [@​mburumaxwell](https://togithub.com/mburumaxwell) in [domaindrivendev/Swashbuckle.AspNetCore#2392 - Add support for required keyword by [@​keahpeters](https://togithub.com/keahpeters) in [domaindrivendev/Swashbuckle.AspNetCore#2810 - Resolves [#​2717](https://togithub.com/domaindrivendev/Swashbuckle.AspNetCore/issues/2717) by [@​MerickOWA](https://togithub.com/MerickOWA) in [domaindrivendev/Swashbuckle.AspNetCore#2718 - Observe the route template constraints in the Swagger middleware by [@​0xced](https://togithub.com/0xced) in [domaindrivendev/Swashbuckle.AspNetCore#2418 - Added Swashbuckle.AspNetCore.Annotations.SwaggerIgnoreAttribute by [@​jcracknell](https://togithub.com/jcracknell) in [domaindrivendev/Swashbuckle.AspNetCore#2610 - Fix schema generation with allOf inheritance by [@​bkoelman](https://togithub.com/bkoelman) in [domaindrivendev/Swashbuckle.AspNetCore#2815 - avoid triple enumeration of formParameters by [@​SimonCropp](https://togithub.com/SimonCropp) in [domaindrivendev/Swashbuckle.AspNetCore#2823 - reduce some linq allocation by [@​SimonCropp](https://togithub.com/SimonCropp) in [domaindrivendev/Swashbuckle.AspNetCore#2819 - remove some duplicate dictionary lookups by [@​SimonCropp](https://togithub.com/SimonCropp) in [domaindrivendev/Swashbuckle.AspNetCore#2822 - remove redundant any check in InferRequestContentTypes by [@​SimonCropp](https://togithub.com/SimonCropp) in [domaindrivendev/Swashbuckle.AspNetCore#2824 - Correctly respect interfaces in `GetInheritanceChain` by [@​angelaki](https://togithub.com/angelaki) in [domaindrivendev/Swashbuckle.AspNetCore#2826 - Generate Enum-Dictionary-Keys (analogous to Newtonsoft) by [@​angelaki](https://togithub.com/angelaki) in [domaindrivendev/Swashbuckle.AspNetCore#2825 - Fix build badge by [@​martincostello](https://togithub.com/martincostello) in [domaindrivendev/Swashbuckle.AspNetCore#2782 - Fix preview package versions by [@​martincostello](https://togithub.com/martincostello) in [domaindrivendev/Swashbuckle.AspNetCore#2783 - Handle Stream and PipeReader content types correctly by [@​martincostello](https://togithub.com/martincostello) in [domaindrivendev/Swashbuckle.AspNetCore#2784 - Add NuGet package READMEs by [@​martincostello](https://togithub.com/martincostello) in [domaindrivendev/Swashbuckle.AspNetCore#2808 - Bump redoc to 2.1.3 by [@​martincostello](https://togithub.com/martincostello) in [domaindrivendev/Swashbuckle.AspNetCore#2807 - Sort system usings first by [@​martincostello](https://togithub.com/martincostello) in [domaindrivendev/Swashbuckle.AspNetCore#2790 - Throw if unsupported HTTP method used by [@​martincostello](https://togithub.com/martincostello) in [domaindrivendev/Swashbuckle.AspNetCore#2797 - Fix configuration properties not being copied by [@​martincostello](https://togithub.com/martincostello) in [domaindrivendev/Swashbuckle.AspNetCore#2796 - Add security policy by [@​martincostello](https://togithub.com/martincostello) in [domaindrivendev/Swashbuckle.AspNetCore#2785 - Bump Microsoft.OpenApi by [@​martincostello](https://togithub.com/martincostello) in [domaindrivendev/Swashbuckle.AspNetCore#2795 - Update to Swagger UI v5 by [@​martincostello](https://togithub.com/martincostello) in [domaindrivendev/Swashbuckle.AspNetCore#2806 - Add customized document serialization support by [@​remcolam](https://togithub.com/remcolam) in [domaindrivendev/Swashbuckle.AspNetCore#2677 - Added documentation for ISwaggerDocumentSerializer by [@​remcolam](https://togithub.com/remcolam) in [domaindrivendev/Swashbuckle.AspNetCore#2837 - Fix flaky tests by locking on the statup type by [@​remcolam](https://togithub.com/remcolam) in [domaindrivendev/Swashbuckle.AspNetCore#2838 - [#​2765](https://togithub.com/domaindrivendev/Swashbuckle.AspNetCore/issues/2765) Allow Filter instance reuse by [@​remcolam](https://togithub.com/remcolam) in [domaindrivendev/Swashbuckle.AspNetCore#2839 - Throw an error when a user uses FromForm attribute with IFormFile in … by [@​nikunjbhargava](https://togithub.com/nikunjbhargava) in [domaindrivendev/Swashbuckle.AspNetCore#2840 - Filter illegal header fields by [@​keahpeters](https://togithub.com/keahpeters) in [domaindrivendev/Swashbuckle.AspNetCore#2842 - Fix handling of FileResult's with content types by [@​IGx89](https://togithub.com/IGx89) in [domaindrivendev/Swashbuckle.AspNetCore#2841 - Adding additional responses when 5XX errors are thrown. by [@​say25](https://togithub.com/say25) in [domaindrivendev/Swashbuckle.AspNetCore#2852 - Fix that XML comment examples do not show up if the type is string and the example contains quotation marks by [@​dldl-cmd](https://togithub.com/dldl-cmd) in [domaindrivendev/Swashbuckle.AspNetCore#2727 - Exclude unused Swagger-UI files by [@​martincostello](https://togithub.com/martincostello) in [domaindrivendev/Swashbuckle.AspNetCore#2851 - Fix RequestBodyFilters not being deep copied by [@​martincostello](https://togithub.com/martincostello) in [domaindrivendev/Swashbuckle.AspNetCore#2850 - Avoid GitHub step summary file write conflicts by [@​martincostello](https://togithub.com/martincostello) in [domaindrivendev/Swashbuckle.AspNetCore#2848 - Extend built-in supported types by [@​martincostello](https://togithub.com/martincostello) in [domaindrivendev/Swashbuckle.AspNetCore#2804 - Update compatibility table by [@​martincostello](https://togithub.com/martincostello) in [domaindrivendev/Swashbuckle.AspNetCore#2856 - Add GitHub issue and PR templates by [@​martincostello](https://togithub.com/martincostello) in [domaindrivendev/Swashbuckle.AspNetCore#2788 - Fix stale permissions by [@​martincostello](https://togithub.com/martincostello) in [domaindrivendev/Swashbuckle.AspNetCore#2855 - Add .NET 8 support by [@​martincostello](https://togithub.com/martincostello) in [domaindrivendev/Swashbuckle.AspNetCore#2799 - Release automation workflows by [@​martincostello](https://togithub.com/martincostello) in [domaindrivendev/Swashbuckle.AspNetCore#2809 - Support native AoT with SwaggerUI by [@​martincostello](https://togithub.com/martincostello) in [domaindrivendev/Swashbuckle.AspNetCore#2800 - Bump some NuGet packages by [@​martincostello](https://togithub.com/martincostello) in [domaindrivendev/Swashbuckle.AspNetCore#2868 - Fix stale permissions by [@​martincostello](https://togithub.com/martincostello) in [domaindrivendev/Swashbuckle.AspNetCore#2863 - Attestation by [@​martincostello](https://togithub.com/martincostello) in [domaindrivendev/Swashbuckle.AspNetCore#2869 - Add descriptions for more HTTP status codes by [@​cremor](https://togithub.com/cremor) in [domaindrivendev/Swashbuckle.AspNetCore#2872 - Only attest packages by [@​martincostello](https://togithub.com/martincostello) in [domaindrivendev/Swashbuckle.AspNetCore#2870 - Fix tag version by [@​martincostello](https://togithub.com/martincostello) in [domaindrivendev/Swashbuckle.AspNetCore#2875 ##### New Contributors - [@​mokarchi](https://togithub.com/mokarchi) made their first contribution in [domaindrivendev/Swashbuckle.AspNetCore#2768 - [@​hwoodiwiss](https://togithub.com/hwoodiwiss) made their first contribution in [domaindrivendev/Swashbuckle.AspNetCore#2414 - [@​Saibamen](https://togithub.com/Saibamen) made their first contribution in [domaindrivendev/Swashbuckle.AspNetCore#2705 - [@​keahpeters](https://togithub.com/keahpeters) made their first contribution in [domaindrivendev/Swashbuckle.AspNetCore#2810 - [@​MerickOWA](https://togithub.com/MerickOWA) made their first contribution in [domaindrivendev/Swashbuckle.AspNetCore#2718 - [@​0xced](https://togithub.com/0xced) made their first contribution in [domaindrivendev/Swashbuckle.AspNetCore#2418 - [@​jcracknell](https://togithub.com/jcracknell) made their first contribution in [domaindrivendev/Swashbuckle.AspNetCore#2610 - [@​bkoelman](https://togithub.com/bkoelman) made their first contribution in [domaindrivendev/Swashbuckle.AspNetCore#2815 - [@​angelaki](https://togithub.com/angelaki) made their first contribution in [domaindrivendev/Swashbuckle.AspNetCore#2826 - [@​remcolam](https://togithub.com/remcolam) made their first contribution in [domaindrivendev/Swashbuckle.AspNetCore#2677 - [@​nikunjbhargava](https://togithub.com/nikunjbhargava) made their first contribution in [domaindrivendev/Swashbuckle.AspNetCore#2840 - [@​IGx89](https://togithub.com/IGx89) made their first contribution in [domaindrivendev/Swashbuckle.AspNetCore#2841 - [@​dldl-cmd](https://togithub.com/dldl-cmd) made their first contribution in [domaindrivendev/Swashbuckle.AspNetCore#2727 - [@​cremor](https://togithub.com/cremor) made their first contribution in [domaindrivendev/Swashbuckle.AspNetCore#2872 **Full Changelog**: domaindrivendev/Swashbuckle.AspNetCore@v6.5.0...v6.6.1 </details> --- ### Configuration 📅 **Schedule**: Branch creation - At any time (no schedule defined), Automerge - At any time (no schedule defined). 🚦 **Automerge**: Disabled by config. Please merge this manually once you are satisfied. ♻ **Rebasing**: Whenever PR becomes conflicted, or you tick the rebase/retry checkbox. 🔕 **Ignore**: Close this PR and you won't be reminded about this update again. --- - [ ] <!-- rebase-check -->If you want to rebase/retry this PR, check this box --- This PR has been generated by [Mend Renovate](https://www.mend.io/free-developer-tools/renovate/). View repository job log [here](https://developer.mend.io/github/gritcsenko/HomeInventory). <!--renovate-debug:eyJjcmVhdGVkSW5WZXIiOiIzNy4zNjMuNSIsInVwZGF0ZWRJblZlciI6IjM3LjM2My41IiwidGFyZ2V0QnJhbmNoIjoibWFpbiIsImxhYmVscyI6W119-->
[![Mend Renovate](https://app.renovatebot.com/images/banner.svg)](https://renovatebot.com) This PR contains the following updates: | Package | Change | Age | Adoption | Passing | Confidence | |---|---|---|---|---|---| | [Swashbuckle.AspNetCore](https://togithub.com/domaindrivendev/Swashbuckle.AspNetCore) | `6.5.0` -> `6.6.1` | [![age](https://developer.mend.io/api/mc/badges/age/nuget/Swashbuckle.AspNetCore/6.6.1?slim=true)](https://docs.renovatebot.com/merge-confidence/) | [![adoption](https://developer.mend.io/api/mc/badges/adoption/nuget/Swashbuckle.AspNetCore/6.6.1?slim=true)](https://docs.renovatebot.com/merge-confidence/) | [![passing](https://developer.mend.io/api/mc/badges/compatibility/nuget/Swashbuckle.AspNetCore/6.5.0/6.6.1?slim=true)](https://docs.renovatebot.com/merge-confidence/) | [![confidence](https://developer.mend.io/api/mc/badges/confidence/nuget/Swashbuckle.AspNetCore/6.5.0/6.6.1?slim=true)](https://docs.renovatebot.com/merge-confidence/) | --- ### Release Notes <details> <summary>domaindrivendev/Swashbuckle.AspNetCore (Swashbuckle.AspNetCore)</summary> ### [`v6.6.1`](https://togithub.com/domaindrivendev/Swashbuckle.AspNetCore/releases/tag/v6.6.1) ##### What's Changed - Modernise build and migrate to GitHub Actions for CI by [@​martincostello](https://togithub.com/martincostello) in [domaindrivendev/Swashbuckle.AspNetCore#2775 - Update Redoc spelling in docs by [@​Quppa](https://togithub.com/Quppa) in [domaindrivendev/Swashbuckle.AspNetCore#2568 - C# 9 Record - Read example/summary from positional record by [@​pixellos](https://togithub.com/pixellos) in [domaindrivendev/Swashbuckle.AspNetCore#2546 - Grammatical correction of some comments by [@​mokarchi](https://togithub.com/mokarchi) in [domaindrivendev/Swashbuckle.AspNetCore#2768 - Update README.md for nested types custom schemaId support by [@​antmeehan](https://togithub.com/antmeehan) in [domaindrivendev/Swashbuckle.AspNetCore#2746 - Add support for `WithSummary` and `WithDescription` metadata by [@​hwoodiwiss](https://togithub.com/hwoodiwiss) in [domaindrivendev/Swashbuckle.AspNetCore#2414 - Update README.md - Fix `Add Security Definitions and Requirements for Bearer auth` URL by [@​Saibamen](https://togithub.com/Saibamen) in [domaindrivendev/Swashbuckle.AspNetCore#2705 - Replace <see href="link">text</see> with Markdown link format by [@​mburumaxwell](https://togithub.com/mburumaxwell) in [domaindrivendev/Swashbuckle.AspNetCore#2392 - Add support for required keyword by [@​keahpeters](https://togithub.com/keahpeters) in [domaindrivendev/Swashbuckle.AspNetCore#2810 - Resolves [#​2717](https://togithub.com/domaindrivendev/Swashbuckle.AspNetCore/issues/2717) by [@​MerickOWA](https://togithub.com/MerickOWA) in [domaindrivendev/Swashbuckle.AspNetCore#2718 - Observe the route template constraints in the Swagger middleware by [@​0xced](https://togithub.com/0xced) in [domaindrivendev/Swashbuckle.AspNetCore#2418 - Added Swashbuckle.AspNetCore.Annotations.SwaggerIgnoreAttribute by [@​jcracknell](https://togithub.com/jcracknell) in [domaindrivendev/Swashbuckle.AspNetCore#2610 - Fix schema generation with allOf inheritance by [@​bkoelman](https://togithub.com/bkoelman) in [domaindrivendev/Swashbuckle.AspNetCore#2815 - avoid triple enumeration of formParameters by [@​SimonCropp](https://togithub.com/SimonCropp) in [domaindrivendev/Swashbuckle.AspNetCore#2823 - reduce some linq allocation by [@​SimonCropp](https://togithub.com/SimonCropp) in [domaindrivendev/Swashbuckle.AspNetCore#2819 - remove some duplicate dictionary lookups by [@​SimonCropp](https://togithub.com/SimonCropp) in [domaindrivendev/Swashbuckle.AspNetCore#2822 - remove redundant any check in InferRequestContentTypes by [@​SimonCropp](https://togithub.com/SimonCropp) in [domaindrivendev/Swashbuckle.AspNetCore#2824 - Correctly respect interfaces in `GetInheritanceChain` by [@​angelaki](https://togithub.com/angelaki) in [domaindrivendev/Swashbuckle.AspNetCore#2826 - Generate Enum-Dictionary-Keys (analogous to Newtonsoft) by [@​angelaki](https://togithub.com/angelaki) in [domaindrivendev/Swashbuckle.AspNetCore#2825 - Fix build badge by [@​martincostello](https://togithub.com/martincostello) in [domaindrivendev/Swashbuckle.AspNetCore#2782 - Fix preview package versions by [@​martincostello](https://togithub.com/martincostello) in [domaindrivendev/Swashbuckle.AspNetCore#2783 - Handle Stream and PipeReader content types correctly by [@​martincostello](https://togithub.com/martincostello) in [domaindrivendev/Swashbuckle.AspNetCore#2784 - Add NuGet package READMEs by [@​martincostello](https://togithub.com/martincostello) in [domaindrivendev/Swashbuckle.AspNetCore#2808 - Bump redoc to 2.1.3 by [@​martincostello](https://togithub.com/martincostello) in [domaindrivendev/Swashbuckle.AspNetCore#2807 - Sort system usings first by [@​martincostello](https://togithub.com/martincostello) in [domaindrivendev/Swashbuckle.AspNetCore#2790 - Throw if unsupported HTTP method used by [@​martincostello](https://togithub.com/martincostello) in [domaindrivendev/Swashbuckle.AspNetCore#2797 - Fix configuration properties not being copied by [@​martincostello](https://togithub.com/martincostello) in [domaindrivendev/Swashbuckle.AspNetCore#2796 - Add security policy by [@​martincostello](https://togithub.com/martincostello) in [domaindrivendev/Swashbuckle.AspNetCore#2785 - Bump Microsoft.OpenApi by [@​martincostello](https://togithub.com/martincostello) in [domaindrivendev/Swashbuckle.AspNetCore#2795 - Update to Swagger UI v5 by [@​martincostello](https://togithub.com/martincostello) in [domaindrivendev/Swashbuckle.AspNetCore#2806 - Add customized document serialization support by [@​remcolam](https://togithub.com/remcolam) in [domaindrivendev/Swashbuckle.AspNetCore#2677 - Added documentation for ISwaggerDocumentSerializer by [@​remcolam](https://togithub.com/remcolam) in [domaindrivendev/Swashbuckle.AspNetCore#2837 - Fix flaky tests by locking on the statup type by [@​remcolam](https://togithub.com/remcolam) in [domaindrivendev/Swashbuckle.AspNetCore#2838 - [#​2765](https://togithub.com/domaindrivendev/Swashbuckle.AspNetCore/issues/2765) Allow Filter instance reuse by [@​remcolam](https://togithub.com/remcolam) in [domaindrivendev/Swashbuckle.AspNetCore#2839 - Throw an error when a user uses FromForm attribute with IFormFile in … by [@​nikunjbhargava](https://togithub.com/nikunjbhargava) in [domaindrivendev/Swashbuckle.AspNetCore#2840 - Filter illegal header fields by [@​keahpeters](https://togithub.com/keahpeters) in [domaindrivendev/Swashbuckle.AspNetCore#2842 - Fix handling of FileResult's with content types by [@​IGx89](https://togithub.com/IGx89) in [domaindrivendev/Swashbuckle.AspNetCore#2841 - Adding additional responses when 5XX errors are thrown. by [@​say25](https://togithub.com/say25) in [domaindrivendev/Swashbuckle.AspNetCore#2852 - Fix that XML comment examples do not show up if the type is string and the example contains quotation marks by [@​dldl-cmd](https://togithub.com/dldl-cmd) in [domaindrivendev/Swashbuckle.AspNetCore#2727 - Exclude unused Swagger-UI files by [@​martincostello](https://togithub.com/martincostello) in [domaindrivendev/Swashbuckle.AspNetCore#2851 - Fix RequestBodyFilters not being deep copied by [@​martincostello](https://togithub.com/martincostello) in [domaindrivendev/Swashbuckle.AspNetCore#2850 - Avoid GitHub step summary file write conflicts by [@​martincostello](https://togithub.com/martincostello) in [domaindrivendev/Swashbuckle.AspNetCore#2848 - Extend built-in supported types by [@​martincostello](https://togithub.com/martincostello) in [domaindrivendev/Swashbuckle.AspNetCore#2804 - Update compatibility table by [@​martincostello](https://togithub.com/martincostello) in [domaindrivendev/Swashbuckle.AspNetCore#2856 - Add GitHub issue and PR templates by [@​martincostello](https://togithub.com/martincostello) in [domaindrivendev/Swashbuckle.AspNetCore#2788 - Fix stale permissions by [@​martincostello](https://togithub.com/martincostello) in [domaindrivendev/Swashbuckle.AspNetCore#2855 - Add .NET 8 support by [@​martincostello](https://togithub.com/martincostello) in [domaindrivendev/Swashbuckle.AspNetCore#2799 - Release automation workflows by [@​martincostello](https://togithub.com/martincostello) in [domaindrivendev/Swashbuckle.AspNetCore#2809 - Support native AoT with SwaggerUI by [@​martincostello](https://togithub.com/martincostello) in [domaindrivendev/Swashbuckle.AspNetCore#2800 - Bump some NuGet packages by [@​martincostello](https://togithub.com/martincostello) in [domaindrivendev/Swashbuckle.AspNetCore#2868 - Fix stale permissions by [@​martincostello](https://togithub.com/martincostello) in [domaindrivendev/Swashbuckle.AspNetCore#2863 - Attestation by [@​martincostello](https://togithub.com/martincostello) in [domaindrivendev/Swashbuckle.AspNetCore#2869 - Add descriptions for more HTTP status codes by [@​cremor](https://togithub.com/cremor) in [domaindrivendev/Swashbuckle.AspNetCore#2872 - Only attest packages by [@​martincostello](https://togithub.com/martincostello) in [domaindrivendev/Swashbuckle.AspNetCore#2870 - Fix tag version by [@​martincostello](https://togithub.com/martincostello) in [domaindrivendev/Swashbuckle.AspNetCore#2875 ##### New Contributors - [@​mokarchi](https://togithub.com/mokarchi) made their first contribution in [domaindrivendev/Swashbuckle.AspNetCore#2768 - [@​hwoodiwiss](https://togithub.com/hwoodiwiss) made their first contribution in [domaindrivendev/Swashbuckle.AspNetCore#2414 - [@​Saibamen](https://togithub.com/Saibamen) made their first contribution in [domaindrivendev/Swashbuckle.AspNetCore#2705 - [@​keahpeters](https://togithub.com/keahpeters) made their first contribution in [domaindrivendev/Swashbuckle.AspNetCore#2810 - [@​MerickOWA](https://togithub.com/MerickOWA) made their first contribution in [domaindrivendev/Swashbuckle.AspNetCore#2718 - [@​0xced](https://togithub.com/0xced) made their first contribution in [domaindrivendev/Swashbuckle.AspNetCore#2418 - [@​jcracknell](https://togithub.com/jcracknell) made their first contribution in [domaindrivendev/Swashbuckle.AspNetCore#2610 - [@​bkoelman](https://togithub.com/bkoelman) made their first contribution in [domaindrivendev/Swashbuckle.AspNetCore#2815 - [@​angelaki](https://togithub.com/angelaki) made their first contribution in [domaindrivendev/Swashbuckle.AspNetCore#2826 - [@​remcolam](https://togithub.com/remcolam) made their first contribution in [domaindrivendev/Swashbuckle.AspNetCore#2677 - [@​nikunjbhargava](https://togithub.com/nikunjbhargava) made their first contribution in [domaindrivendev/Swashbuckle.AspNetCore#2840 - [@​IGx89](https://togithub.com/IGx89) made their first contribution in [domaindrivendev/Swashbuckle.AspNetCore#2841 - [@​dldl-cmd](https://togithub.com/dldl-cmd) made their first contribution in [domaindrivendev/Swashbuckle.AspNetCore#2727 - [@​cremor](https://togithub.com/cremor) made their first contribution in [domaindrivendev/Swashbuckle.AspNetCore#2872 **Full Changelog**: domaindrivendev/Swashbuckle.AspNetCore@v6.5.0...v6.6.1 </details> --- ### Configuration 📅 **Schedule**: Branch creation - "after 10pm every weekday,every weekend,before 5am every weekday" in timezone Europe/Berlin, Automerge - At any time (no schedule defined). 🚦 **Automerge**: Enabled. ♻ **Rebasing**: Whenever PR becomes conflicted, or you tick the rebase/retry checkbox. 🔕 **Ignore**: Close this PR and you won't be reminded about this update again. --- - [ ] <!-- rebase-check -->If you want to rebase/retry this PR, check this box --- This PR has been generated by [Mend Renovate](https://www.mend.io/free-developer-tools/renovate/). View repository job log [here](https://developer.mend.io/github/orso-co/Orso.Arpa.Api). <!--renovate-debug:eyJjcmVhdGVkSW5WZXIiOiIzNy4zNTEuMiIsInVwZGF0ZWRJblZlciI6IjM3LjM1MS4yIiwidGFyZ2V0QnJhbmNoIjoiZGV2ZWxvcCIsImxhYmVscyI6W119--> Co-authored-by: renovate[bot] <29139614+renovate[bot]@users.noreply.github.com>
[![Mend Renovate](https://app.renovatebot.com/images/banner.svg)](https://renovatebot.com) This PR contains the following updates: | Package | Change | Age | Adoption | Passing | Confidence | |---|---|---|---|---|---| | [Swashbuckle.AspNetCore](https://togithub.com/domaindrivendev/Swashbuckle.AspNetCore) | `6.5.0` -> `6.6.2` | [![age](https://developer.mend.io/api/mc/badges/age/nuget/Swashbuckle.AspNetCore/6.6.2?slim=true)](https://docs.renovatebot.com/merge-confidence/) | [![adoption](https://developer.mend.io/api/mc/badges/adoption/nuget/Swashbuckle.AspNetCore/6.6.2?slim=true)](https://docs.renovatebot.com/merge-confidence/) | [![passing](https://developer.mend.io/api/mc/badges/compatibility/nuget/Swashbuckle.AspNetCore/6.5.0/6.6.2?slim=true)](https://docs.renovatebot.com/merge-confidence/) | [![confidence](https://developer.mend.io/api/mc/badges/confidence/nuget/Swashbuckle.AspNetCore/6.5.0/6.6.2?slim=true)](https://docs.renovatebot.com/merge-confidence/) | | [Swashbuckle.AspNetCore.Annotations](https://togithub.com/domaindrivendev/Swashbuckle.AspNetCore) | `6.5.0` -> `6.6.2` | [![age](https://developer.mend.io/api/mc/badges/age/nuget/Swashbuckle.AspNetCore.Annotations/6.6.2?slim=true)](https://docs.renovatebot.com/merge-confidence/) | [![adoption](https://developer.mend.io/api/mc/badges/adoption/nuget/Swashbuckle.AspNetCore.Annotations/6.6.2?slim=true)](https://docs.renovatebot.com/merge-confidence/) | [![passing](https://developer.mend.io/api/mc/badges/compatibility/nuget/Swashbuckle.AspNetCore.Annotations/6.5.0/6.6.2?slim=true)](https://docs.renovatebot.com/merge-confidence/) | [![confidence](https://developer.mend.io/api/mc/badges/confidence/nuget/Swashbuckle.AspNetCore.Annotations/6.5.0/6.6.2?slim=true)](https://docs.renovatebot.com/merge-confidence/) | --- ### Release Notes <details> <summary>domaindrivendev/Swashbuckle.AspNetCore (Swashbuckle.AspNetCore)</summary> ### [`v6.6.2`](https://togithub.com/domaindrivendev/Swashbuckle.AspNetCore/releases/tag/v6.6.2) #### What's Changed - Fix to make required and nullable properties nullable in schema by [@​keahpeters](https://togithub.com/keahpeters) in [domaindrivendev/Swashbuckle.AspNetCore#2879 - Update Swagger UI section in README by [@​cremor](https://togithub.com/cremor) in [domaindrivendev/Swashbuckle.AspNetCore#2883 - Add support for the `[Length]`attribute. by [@​satma0745](https://togithub.com/satma0745) in [domaindrivendev/Swashbuckle.AspNetCore#2882 - Existing output file should be deleted/overwritten by [@​patrikwlund](https://togithub.com/patrikwlund) in [domaindrivendev/Swashbuckle.AspNetCore#2886 - Fix libraries being handled as test projects by [@​patrikwlund](https://togithub.com/patrikwlund) in [domaindrivendev/Swashbuckle.AspNetCore#2898 - Avoid competing swagger generation during test build by [@​patrikwlund](https://togithub.com/patrikwlund) in [domaindrivendev/Swashbuckle.AspNetCore#2897 - Replace `<br />`, `<br/>`, and `<br>` in XML comments with `Environment.Newline` by [@​mburumaxwell](https://togithub.com/mburumaxwell) in [domaindrivendev/Swashbuckle.AspNetCore#2899 - Fix schema generation for [c#9](https://togithub.com/c/Swashbuckle.AspNetCore/issues/9) positional record with param tag without example property creating unexpected empty example by [@​stb-co](https://togithub.com/stb-co) in [domaindrivendev/Swashbuckle.AspNetCore#2901 - Fix serialization of `AdditionalItems` by [@​martincostello](https://togithub.com/martincostello) in [domaindrivendev/Swashbuckle.AspNetCore#2890 - Disable parallel build by [@​martincostello](https://togithub.com/martincostello) in [domaindrivendev/Swashbuckle.AspNetCore#2894 - Do not run `IHostedService` implementations by [@​martincostello](https://togithub.com/martincostello) in [domaindrivendev/Swashbuckle.AspNetCore#2880 - Fix interceptor JSON casing by [@​martincostello](https://togithub.com/martincostello) in [domaindrivendev/Swashbuckle.AspNetCore#2907 - Fix generation when `[DefaultValue]`'s type differs by [@​martincostello](https://togithub.com/martincostello) in [domaindrivendev/Swashbuckle.AspNetCore#2895 #### New Contributors - [@​satma0745](https://togithub.com/satma0745) made their first contribution in [domaindrivendev/Swashbuckle.AspNetCore#2882 - [@​patrikwlund](https://togithub.com/patrikwlund) made their first contribution in [domaindrivendev/Swashbuckle.AspNetCore#2886 - [@​stb-co](https://togithub.com/stb-co) made their first contribution in [domaindrivendev/Swashbuckle.AspNetCore#2901 **Full Changelog**: domaindrivendev/Swashbuckle.AspNetCore@v6.6.1...v6.6.2 ### [`v6.6.1`](https://togithub.com/domaindrivendev/Swashbuckle.AspNetCore/releases/tag/v6.6.1) #### What's Changed - Modernise build and migrate to GitHub Actions for CI by [@​martincostello](https://togithub.com/martincostello) in [domaindrivendev/Swashbuckle.AspNetCore#2775 - Update Redoc spelling in docs by [@​Quppa](https://togithub.com/Quppa) in [domaindrivendev/Swashbuckle.AspNetCore#2568 - C# 9 Record - Read example/summary from positional record by [@​pixellos](https://togithub.com/pixellos) in [domaindrivendev/Swashbuckle.AspNetCore#2546 - Grammatical correction of some comments by [@​mokarchi](https://togithub.com/mokarchi) in [domaindrivendev/Swashbuckle.AspNetCore#2768 - Update README.md for nested types custom schemaId support by [@​antmeehan](https://togithub.com/antmeehan) in [domaindrivendev/Swashbuckle.AspNetCore#2746 - Add support for `WithSummary` and `WithDescription` metadata by [@​hwoodiwiss](https://togithub.com/hwoodiwiss) in [domaindrivendev/Swashbuckle.AspNetCore#2414 - Update README.md - Fix `Add Security Definitions and Requirements for Bearer auth` URL by [@​Saibamen](https://togithub.com/Saibamen) in [domaindrivendev/Swashbuckle.AspNetCore#2705 - Replace <see href="link">text</see> with Markdown link format by [@​mburumaxwell](https://togithub.com/mburumaxwell) in [domaindrivendev/Swashbuckle.AspNetCore#2392 - Add support for required keyword by [@​keahpeters](https://togithub.com/keahpeters) in [domaindrivendev/Swashbuckle.AspNetCore#2810 - Resolves [#​2717](https://togithub.com/domaindrivendev/Swashbuckle.AspNetCore/issues/2717) by [@​MerickOWA](https://togithub.com/MerickOWA) in [domaindrivendev/Swashbuckle.AspNetCore#2718 - Observe the route template constraints in the Swagger middleware by [@​0xced](https://togithub.com/0xced) in [domaindrivendev/Swashbuckle.AspNetCore#2418 - Added Swashbuckle.AspNetCore.Annotations.SwaggerIgnoreAttribute by [@​jcracknell](https://togithub.com/jcracknell) in [domaindrivendev/Swashbuckle.AspNetCore#2610 - Fix schema generation with allOf inheritance by [@​bkoelman](https://togithub.com/bkoelman) in [domaindrivendev/Swashbuckle.AspNetCore#2815 - avoid triple enumeration of formParameters by [@​SimonCropp](https://togithub.com/SimonCropp) in [domaindrivendev/Swashbuckle.AspNetCore#2823 - reduce some linq allocation by [@​SimonCropp](https://togithub.com/SimonCropp) in [domaindrivendev/Swashbuckle.AspNetCore#2819 - remove some duplicate dictionary lookups by [@​SimonCropp](https://togithub.com/SimonCropp) in [domaindrivendev/Swashbuckle.AspNetCore#2822 - remove redundant any check in InferRequestContentTypes by [@​SimonCropp](https://togithub.com/SimonCropp) in [domaindrivendev/Swashbuckle.AspNetCore#2824 - Correctly respect interfaces in `GetInheritanceChain` by [@​angelaki](https://togithub.com/angelaki) in [domaindrivendev/Swashbuckle.AspNetCore#2826 - Generate Enum-Dictionary-Keys (analogous to Newtonsoft) by [@​angelaki](https://togithub.com/angelaki) in [domaindrivendev/Swashbuckle.AspNetCore#2825 - Fix build badge by [@​martincostello](https://togithub.com/martincostello) in [domaindrivendev/Swashbuckle.AspNetCore#2782 - Fix preview package versions by [@​martincostello](https://togithub.com/martincostello) in [domaindrivendev/Swashbuckle.AspNetCore#2783 - Handle Stream and PipeReader content types correctly by [@​martincostello](https://togithub.com/martincostello) in [domaindrivendev/Swashbuckle.AspNetCore#2784 - Add NuGet package READMEs by [@​martincostello](https://togithub.com/martincostello) in [domaindrivendev/Swashbuckle.AspNetCore#2808 - Bump redoc to 2.1.3 by [@​martincostello](https://togithub.com/martincostello) in [domaindrivendev/Swashbuckle.AspNetCore#2807 - Sort system usings first by [@​martincostello](https://togithub.com/martincostello) in [domaindrivendev/Swashbuckle.AspNetCore#2790 - Throw if unsupported HTTP method used by [@​martincostello](https://togithub.com/martincostello) in [domaindrivendev/Swashbuckle.AspNetCore#2797 - Fix configuration properties not being copied by [@​martincostello](https://togithub.com/martincostello) in [domaindrivendev/Swashbuckle.AspNetCore#2796 - Add security policy by [@​martincostello](https://togithub.com/martincostello) in [domaindrivendev/Swashbuckle.AspNetCore#2785 - Bump Microsoft.OpenApi by [@​martincostello](https://togithub.com/martincostello) in [domaindrivendev/Swashbuckle.AspNetCore#2795 - Update to Swagger UI v5 by [@​martincostello](https://togithub.com/martincostello) in [domaindrivendev/Swashbuckle.AspNetCore#2806 - Add customized document serialization support by [@​remcolam](https://togithub.com/remcolam) in [domaindrivendev/Swashbuckle.AspNetCore#2677 - Added documentation for ISwaggerDocumentSerializer by [@​remcolam](https://togithub.com/remcolam) in [domaindrivendev/Swashbuckle.AspNetCore#2837 - Fix flaky tests by locking on the statup type by [@​remcolam](https://togithub.com/remcolam) in [domaindrivendev/Swashbuckle.AspNetCore#2838 - [#​2765](https://togithub.com/domaindrivendev/Swashbuckle.AspNetCore/issues/2765) Allow Filter instance reuse by [@​remcolam](https://togithub.com/remcolam) in [domaindrivendev/Swashbuckle.AspNetCore#2839 - Throw an error when a user uses FromForm attribute with IFormFile in … by [@​nikunjbhargava](https://togithub.com/nikunjbhargava) in [domaindrivendev/Swashbuckle.AspNetCore#2840 - Filter illegal header fields by [@​keahpeters](https://togithub.com/keahpeters) in [domaindrivendev/Swashbuckle.AspNetCore#2842 - Fix handling of FileResult's with content types by [@​IGx89](https://togithub.com/IGx89) in [domaindrivendev/Swashbuckle.AspNetCore#2841 - Adding additional responses when 5XX errors are thrown. by [@​say25](https://togithub.com/say25) in [domaindrivendev/Swashbuckle.AspNetCore#2852 - Fix that XML comment examples do not show up if the type is string and the example contains quotation marks by [@​dldl-cmd](https://togithub.com/dldl-cmd) in [domaindrivendev/Swashbuckle.AspNetCore#2727 - Exclude unused Swagger-UI files by [@​martincostello](https://togithub.com/martincostello) in [domaindrivendev/Swashbuckle.AspNetCore#2851 - Fix RequestBodyFilters not being deep copied by [@​martincostello](https://togithub.com/martincostello) in [domaindrivendev/Swashbuckle.AspNetCore#2850 - Avoid GitHub step summary file write conflicts by [@​martincostello](https://togithub.com/martincostello) in [domaindrivendev/Swashbuckle.AspNetCore#2848 - Extend built-in supported types by [@​martincostello](https://togithub.com/martincostello) in [domaindrivendev/Swashbuckle.AspNetCore#2804 - Update compatibility table by [@​martincostello](https://togithub.com/martincostello) in [domaindrivendev/Swashbuckle.AspNetCore#2856 - Add GitHub issue and PR templates by [@​martincostello](https://togithub.com/martincostello) in [domaindrivendev/Swashbuckle.AspNetCore#2788 - Fix stale permissions by [@​martincostello](https://togithub.com/martincostello) in [domaindrivendev/Swashbuckle.AspNetCore#2855 - Add .NET 8 support by [@​martincostello](https://togithub.com/martincostello) in [domaindrivendev/Swashbuckle.AspNetCore#2799 - Release automation workflows by [@​martincostello](https://togithub.com/martincostello) in [domaindrivendev/Swashbuckle.AspNetCore#2809 - Support native AoT with SwaggerUI by [@​martincostello](https://togithub.com/martincostello) in [domaindrivendev/Swashbuckle.AspNetCore#2800 - Bump some NuGet packages by [@​martincostello](https://togithub.com/martincostello) in [domaindrivendev/Swashbuckle.AspNetCore#2868 - Fix stale permissions by [@​martincostello](https://togithub.com/martincostello) in [domaindrivendev/Swashbuckle.AspNetCore#2863 - Attestation by [@​martincostello](https://togithub.com/martincostello) in [domaindrivendev/Swashbuckle.AspNetCore#2869 - Add descriptions for more HTTP status codes by [@​cremor](https://togithub.com/cremor) in [domaindrivendev/Swashbuckle.AspNetCore#2872 - Only attest packages by [@​martincostello](https://togithub.com/martincostello) in [domaindrivendev/Swashbuckle.AspNetCore#2870 - Fix tag version by [@​martincostello](https://togithub.com/martincostello) in [domaindrivendev/Swashbuckle.AspNetCore#2875 #### New Contributors - [@​mokarchi](https://togithub.com/mokarchi) made their first contribution in [domaindrivendev/Swashbuckle.AspNetCore#2768 - [@​hwoodiwiss](https://togithub.com/hwoodiwiss) made their first contribution in [domaindrivendev/Swashbuckle.AspNetCore#2414 - [@​Saibamen](https://togithub.com/Saibamen) made their first contribution in [domaindrivendev/Swashbuckle.AspNetCore#2705 - [@​keahpeters](https://togithub.com/keahpeters) made their first contribution in [domaindrivendev/Swashbuckle.AspNetCore#2810 - [@​MerickOWA](https://togithub.com/MerickOWA) made their first contribution in [domaindrivendev/Swashbuckle.AspNetCore#2718 - [@​0xced](https://togithub.com/0xced) made their first contribution in [domaindrivendev/Swashbuckle.AspNetCore#2418 - [@​jcracknell](https://togithub.com/jcracknell) made their first contribution in [domaindrivendev/Swashbuckle.AspNetCore#2610 - [@​bkoelman](https://togithub.com/bkoelman) made their first contribution in [domaindrivendev/Swashbuckle.AspNetCore#2815 - [@​angelaki](https://togithub.com/angelaki) made their first contribution in [domaindrivendev/Swashbuckle.AspNetCore#2826 - [@​remcolam](https://togithub.com/remcolam) made their first contribution in [domaindrivendev/Swashbuckle.AspNetCore#2677 - [@​nikunjbhargava](https://togithub.com/nikunjbhargava) made their first contribution in [domaindrivendev/Swashbuckle.AspNetCore#2840 - [@​IGx89](https://togithub.com/IGx89) made their first contribution in [domaindrivendev/Swashbuckle.AspNetCore#2841 - [@​dldl-cmd](https://togithub.com/dldl-cmd) made their first contribution in [domaindrivendev/Swashbuckle.AspNetCore#2727 - [@​cremor](https://togithub.com/cremor) made their first contribution in [domaindrivendev/Swashbuckle.AspNetCore#2872 **Full Changelog**: domaindrivendev/Swashbuckle.AspNetCore@v6.5.0...v6.6.1 </details> --- ### Configuration 📅 **Schedule**: Branch creation - "after 9pm,before 6am" in timezone Europe/Zurich, Automerge - At any time (no schedule defined). 🚦 **Automerge**: Enabled. ♻ **Rebasing**: Whenever PR becomes conflicted, or you tick the rebase/retry checkbox. 🔕 **Ignore**: Close this PR and you won't be reminded about these updates again. --- - [ ] <!-- rebase-check -->If you want to rebase/retry this PR, check this box --- This PR has been generated by [Mend Renovate](https://www.mend.io/free-developer-tools/renovate/). View repository job log [here](https://developer.mend.io/github/smartive/cas-fee-adv-mumble-api). <!--renovate-debug:eyJjcmVhdGVkSW5WZXIiOiIzNy4zNTEuMiIsInVwZGF0ZWRJblZlciI6IjM3LjM2OC4xMCIsInRhcmdldEJyYW5jaCI6Im1haW4iLCJsYWJlbHMiOlsiZGVwZW5kZW5jaWVzIl19--> Co-authored-by: renovate[bot] <29139614+renovate[bot]@users.noreply.github.com>