-
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
Apply only a SchemaFilter to create the Description on the SwaggerUi #2943
Apply only a SchemaFilter to create the Description on the SwaggerUi #2943
Conversation
Codecov ReportAll modified and coverable lines are covered by tests ✅
❗ Your organization needs to install the Codecov GitHub app to enable full functionality. Additional details and impacted files@@ Coverage Diff @@
## master #2943 +/- ##
==========================================
+ Coverage 90.10% 90.13% +0.02%
==========================================
Files 72 72
Lines 2730 2736 +6
Branches 432 433 +1
==========================================
+ Hits 2460 2466 +6
Misses 270 270
Flags with carried forward coverage won't be shown. Click here to find out more. ☔ View full report in Codecov by Sentry. |
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.
Are you able to add an integration test for this scenario too?
test/Swashbuckle.AspNetCore.SwaggerGen.Test/SwaggerGenerator/SwaggerGeneratorTests.cs
Outdated
Show resolved
Hide resolved
Finally I gave up, because the Verify test was giving different response in the linux build |
Do you use an editor that supports EditorConfig? The .editorconfig and .gitattributes are both configured so that line endings shouldn't be an issue, unless I've misunderstood how it works. Alternatively, does it have a setting that allows us to tell it to ignore line ending differences? |
As soon as I insert the Verify again the build fails, I do not see why it failed now. |
.../SwaggerGeneratorVerifyTests.GetSwagger_Copies_Description_From_GeneratedSchema.verified.txt
Outdated
Show resolved
Hide resolved
Could you rebase onto the latest changes please? I just merged #2950 which added a bunch of new verification tests and this change might impact them and need regenerating. |
...buckle.AspNetCore.SwaggerGen.Test/SwaggerGeneratorVerifyTests/SwaggerGeneratorVerifyTests.cs
Show resolved
Hide resolved
[![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.6.2` -> `6.7.0` | [![age](https://developer.mend.io/api/mc/badges/age/nuget/Swashbuckle.AspNetCore/6.7.0?slim=true)](https://docs.renovatebot.com/merge-confidence/) | [![adoption](https://developer.mend.io/api/mc/badges/adoption/nuget/Swashbuckle.AspNetCore/6.7.0?slim=true)](https://docs.renovatebot.com/merge-confidence/) | [![passing](https://developer.mend.io/api/mc/badges/compatibility/nuget/Swashbuckle.AspNetCore/6.6.2/6.7.0?slim=true)](https://docs.renovatebot.com/merge-confidence/) | [![confidence](https://developer.mend.io/api/mc/badges/confidence/nuget/Swashbuckle.AspNetCore/6.6.2/6.7.0?slim=true)](https://docs.renovatebot.com/merge-confidence/) | --- ### Release Notes <details> <summary>domaindrivendev/Swashbuckle.AspNetCore (Swashbuckle.AspNetCore)</summary> ### [`v6.7.0`](https://togithub.com/domaindrivendev/Swashbuckle.AspNetCore/releases/tag/v6.7.0) ##### What's Changed - Allow Swagger UI CSS and JS paths to be configurable by [@​mag1art](https://togithub.com/mag1art) in [domaindrivendev/Swashbuckle.AspNetCore#2908 - Add `IncludeXmlCommentsForAssembly()` convience overload by [@​leotsarev](https://togithub.com/leotsarev) in [domaindrivendev/Swashbuckle.AspNetCore#2909 - Add snapshot tests using Verify by [@​keahpeters](https://togithub.com/keahpeters) in [domaindrivendev/Swashbuckle.AspNetCore#2929 - Add posibility to ignore properties in `[FromForm]` with `[SwaggerIgnore]` by [@​jgarciadelanoceda](https://togithub.com/jgarciadelanoceda) in [domaindrivendev/Swashbuckle.AspNetCore#2928 - Adding check for existing directory and creating if doesn't exist by [@​matt-lethargic](https://togithub.com/matt-lethargic) in [domaindrivendev/Swashbuckle.AspNetCore#2927 - Default null value on nullable types caused errors by [@​jgarciadelanoceda](https://togithub.com/jgarciadelanoceda) in [domaindrivendev/Swashbuckle.AspNetCore#2941 - Add additional Verify tests by [@​keahpeters](https://togithub.com/keahpeters) in [domaindrivendev/Swashbuckle.AspNetCore#2950 - Only apply a SchemaFilter to create the description on SwaggerUI by [@​jgarciadelanoceda](https://togithub.com/jgarciadelanoceda) in [domaindrivendev/Swashbuckle.AspNetCore#2943 - Add support for async filters by [@​mauve](https://togithub.com/mauve) in [domaindrivendev/Swashbuckle.AspNetCore#2938 - Fix package validation by [@​martincostello](https://togithub.com/martincostello) in [domaindrivendev/Swashbuckle.AspNetCore#2926 - Adding support for .NET 8 Model State attributes by [@​jgarciadelanoceda](https://togithub.com/jgarciadelanoceda) in [domaindrivendev/Swashbuckle.AspNetCore#2958 - Only set Exclusive Range when they are by [@​jgarciadelanoceda](https://togithub.com/jgarciadelanoceda) in [domaindrivendev/Swashbuckle.AspNetCore#2960 - `[AsParameters]` throwing error on cast when showing the description with `EnableAnnotations()` by [@​jgarciadelanoceda](https://togithub.com/jgarciadelanoceda) in [domaindrivendev/Swashbuckle.AspNetCore#2962 - Fix `RequestBodyFilterAnnotation` and `MultipleFromForm` for Minimal APIs by [@​jgarciadelanoceda](https://togithub.com/jgarciadelanoceda) in [domaindrivendev/Swashbuckle.AspNetCore#2963 - Swagger UI refactoring by [@​martincostello](https://togithub.com/martincostello) in [domaindrivendev/Swashbuckle.AspNetCore#2942 - Add help wanted badge by [@​martincostello](https://togithub.com/martincostello) in [domaindrivendev/Swashbuckle.AspNetCore#2911 - Move inline css and js to external files for SwaggerUI and ReDoc by [@​junior-santana](https://togithub.com/junior-santana) in [domaindrivendev/Swashbuckle.AspNetCore#2965 - Missing properties section when generating `IFomFile`/`IFormFileCollection` by [@​jgarciadelanoceda](https://togithub.com/jgarciadelanoceda) in [domaindrivendev/Swashbuckle.AspNetCore#2972 - Missing Encoding and RequiredProperties when `IFormFile` with OpenAPI by [@​jgarciadelanoceda](https://togithub.com/jgarciadelanoceda) in [domaindrivendev/Swashbuckle.AspNetCore#2979 - Use `ApiParameter.Type` by [@​jgarciadelanoceda](https://togithub.com/jgarciadelanoceda) in [domaindrivendev/Swashbuckle.AspNetCore#2980 - Document arrays of generic parameters with XML comments and support overload methods by [@​jgarciadelanoceda](https://togithub.com/jgarciadelanoceda) in [domaindrivendev/Swashbuckle.AspNetCore#2982 - Take into account \[JsonRequired] for System.Text.Json by [@​jgarciadelanoceda](https://togithub.com/jgarciadelanoceda) in [domaindrivendev/Swashbuckle.AspNetCore#2988 - Configure non-nullable types as required by [@​AntiGuideAkquinet](https://togithub.com/AntiGuideAkquinet) in [domaindrivendev/Swashbuckle.AspNetCore#2803 - Use `HttpMethods.IsGet()` by [@​martincostello](https://togithub.com/martincostello) in [domaindrivendev/Swashbuckle.AspNetCore#2971 ##### New Contributors - [@​mag1art](https://togithub.com/mag1art) made their first contribution in [domaindrivendev/Swashbuckle.AspNetCore#2908 - [@​jgarciadelanoceda](https://togithub.com/jgarciadelanoceda) made their first contribution in [domaindrivendev/Swashbuckle.AspNetCore#2928 - [@​matt-lethargic](https://togithub.com/matt-lethargic) made their first contribution in [domaindrivendev/Swashbuckle.AspNetCore#2927 - [@​mauve](https://togithub.com/mauve) made their first contribution in [domaindrivendev/Swashbuckle.AspNetCore#2938 - [@​junior-santana](https://togithub.com/junior-santana) made their first contribution in [domaindrivendev/Swashbuckle.AspNetCore#2965 - [@​AntiGuideAkquinet](https://togithub.com/AntiGuideAkquinet) made their first contribution in [domaindrivendev/Swashbuckle.AspNetCore#2803 **Full Changelog**: domaindrivendev/Swashbuckle.AspNetCore@v6.6.2...v6.7.0 </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 was generated by [Mend Renovate](https://www.mend.io/free-developer-tools/renovate/). View the [repository job log](https://developer.mend.io/github/orso-co/Orso.Arpa.Api). <!--renovate-debug:eyJjcmVhdGVkSW5WZXIiOiIzNy40NDAuNyIsInVwZGF0ZWRJblZlciI6IjM3LjQ0MC43IiwidGFyZ2V0QnJhbmNoIjoiZGV2ZWxvcCIsImxhYmVscyI6W119--> Co-authored-by: renovate[bot] <29139614+renovate[bot]@users.noreply.github.com>
This PR contains the following updates: | Package | Change | Age | Adoption | Passing | Confidence | |---|---|---|---|---|---| | [Swashbuckle.AspNetCore](https://togithub.com/domaindrivendev/Swashbuckle.AspNetCore) | `6.6.2` -> `6.7.3` | [![age](https://developer.mend.io/api/mc/badges/age/nuget/Swashbuckle.AspNetCore/6.7.3?slim=true)](https://docs.renovatebot.com/merge-confidence/) | [![adoption](https://developer.mend.io/api/mc/badges/adoption/nuget/Swashbuckle.AspNetCore/6.7.3?slim=true)](https://docs.renovatebot.com/merge-confidence/) | [![passing](https://developer.mend.io/api/mc/badges/compatibility/nuget/Swashbuckle.AspNetCore/6.6.2/6.7.3?slim=true)](https://docs.renovatebot.com/merge-confidence/) | [![confidence](https://developer.mend.io/api/mc/badges/confidence/nuget/Swashbuckle.AspNetCore/6.6.2/6.7.3?slim=true)](https://docs.renovatebot.com/merge-confidence/) | | [Swashbuckle.AspNetCore.Annotations](https://togithub.com/domaindrivendev/Swashbuckle.AspNetCore) | `6.6.2` -> `6.7.3` | [![age](https://developer.mend.io/api/mc/badges/age/nuget/Swashbuckle.AspNetCore.Annotations/6.7.3?slim=true)](https://docs.renovatebot.com/merge-confidence/) | [![adoption](https://developer.mend.io/api/mc/badges/adoption/nuget/Swashbuckle.AspNetCore.Annotations/6.7.3?slim=true)](https://docs.renovatebot.com/merge-confidence/) | [![passing](https://developer.mend.io/api/mc/badges/compatibility/nuget/Swashbuckle.AspNetCore.Annotations/6.6.2/6.7.3?slim=true)](https://docs.renovatebot.com/merge-confidence/) | [![confidence](https://developer.mend.io/api/mc/badges/confidence/nuget/Swashbuckle.AspNetCore.Annotations/6.6.2/6.7.3?slim=true)](https://docs.renovatebot.com/merge-confidence/) | --- ### Release Notes <details> <summary>domaindrivendev/Swashbuckle.AspNetCore (Swashbuckle.AspNetCore)</summary> ### [`v6.7.3`](https://togithub.com/domaindrivendev/Swashbuckle.AspNetCore/releases/tag/v6.7.3) ##### What's Changed - Fix nested types nullable context check by [@​VladimirTyrin](https://togithub.com/VladimirTyrin) in [domaindrivendev/Swashbuckle.AspNetCore#3043 - Use NullabilityInfoContext to determine if member is nullable by [@​patrikwlund](https://togithub.com/patrikwlund) in [domaindrivendev/Swashbuckle.AspNetCore#3046 ##### New Contributors - [@​VladimirTyrin](https://togithub.com/VladimirTyrin) made their first contribution in [domaindrivendev/Swashbuckle.AspNetCore#3043 **Full Changelog**: domaindrivendev/Swashbuckle.AspNetCore@v6.7.2...v6.7.3 ### [`v6.7.2`](https://togithub.com/domaindrivendev/Swashbuckle.AspNetCore/releases/tag/v6.7.2) #### What's Changed - Use NullabilityInfoContext to determine dictionary value nullability by [@​patrikwlund](https://togithub.com/patrikwlund) in [domaindrivendev/Swashbuckle.AspNetCore#3041 **Full Changelog**: domaindrivendev/Swashbuckle.AspNetCore@v6.7.1...v6.7.2 ### [`v6.7.1`](https://togithub.com/domaindrivendev/Swashbuckle.AspNetCore/releases/tag/v6.7.1) #### What's Changed - docs: Update README.md by [@​WeihanLi](https://togithub.com/WeihanLi) in [domaindrivendev/Swashbuckle.AspNetCore#3002 - Support `[DataMember]` `IsRequired` in `NewtonsoftDataContractResolver` by [@​ouvreboite](https://togithub.com/ouvreboite) in [domaindrivendev/Swashbuckle.AspNetCore#2644 - Add API analysers by [@​martincostello](https://togithub.com/martincostello) in [domaindrivendev/Swashbuckle.AspNetCore#3003 - Update README by [@​martincostello](https://togithub.com/martincostello) in [domaindrivendev/Swashbuckle.AspNetCore#3004 - docs: fix example code formatting by [@​WeihanLi](https://togithub.com/WeihanLi) in [domaindrivendev/Swashbuckle.AspNetCore#3010 - Fixes nullability problems with dictionaries by [@​ozziepeeps](https://togithub.com/ozziepeeps) in [domaindrivendev/Swashbuckle.AspNetCore#3023 - Fix handling of nullable structs by [@​martincostello](https://togithub.com/martincostello) in [domaindrivendev/Swashbuckle.AspNetCore#3015 - Fix missing form parameter XML documentation by [@​martincostello](https://togithub.com/martincostello) in [domaindrivendev/Swashbuckle.AspNetCore#3020 #### New Contributors - [@​ouvreboite](https://togithub.com/ouvreboite) made their first contribution in [domaindrivendev/Swashbuckle.AspNetCore#2644 **Full Changelog**: domaindrivendev/Swashbuckle.AspNetCore@v6.7.0...v6.7.1 ### [`v6.7.0`](https://togithub.com/domaindrivendev/Swashbuckle.AspNetCore/releases/tag/v6.7.0) #### What's Changed - Allow Swagger UI CSS and JS paths to be configurable by [@​mag1art](https://togithub.com/mag1art) in [domaindrivendev/Swashbuckle.AspNetCore#2908 - Add `IncludeXmlCommentsForAssembly()` convience overload by [@​leotsarev](https://togithub.com/leotsarev) in [domaindrivendev/Swashbuckle.AspNetCore#2909 - Add snapshot tests using Verify by [@​keahpeters](https://togithub.com/keahpeters) in [domaindrivendev/Swashbuckle.AspNetCore#2929 - Add posibility to ignore properties in `[FromForm]` with `[SwaggerIgnore]` by [@​jgarciadelanoceda](https://togithub.com/jgarciadelanoceda) in [domaindrivendev/Swashbuckle.AspNetCore#2928 - Adding check for existing directory and creating if doesn't exist by [@​matt-lethargic](https://togithub.com/matt-lethargic) in [domaindrivendev/Swashbuckle.AspNetCore#2927 - Default null value on nullable types caused errors by [@​jgarciadelanoceda](https://togithub.com/jgarciadelanoceda) in [domaindrivendev/Swashbuckle.AspNetCore#2941 - Add additional Verify tests by [@​keahpeters](https://togithub.com/keahpeters) in [domaindrivendev/Swashbuckle.AspNetCore#2950 - Only apply a SchemaFilter to create the description on SwaggerUI by [@​jgarciadelanoceda](https://togithub.com/jgarciadelanoceda) in [domaindrivendev/Swashbuckle.AspNetCore#2943 - Add support for async filters by [@​mauve](https://togithub.com/mauve) in [domaindrivendev/Swashbuckle.AspNetCore#2938 - Fix package validation by [@​martincostello](https://togithub.com/martincostello) in [domaindrivendev/Swashbuckle.AspNetCore#2926 - Adding support for .NET 8 Model State attributes by [@​jgarciadelanoceda](https://togithub.com/jgarciadelanoceda) in [domaindrivendev/Swashbuckle.AspNetCore#2958 - Only set Exclusive Range when they are by [@​jgarciadelanoceda](https://togithub.com/jgarciadelanoceda) in [domaindrivendev/Swashbuckle.AspNetCore#2960 - `[AsParameters]` throwing error on cast when showing the description with `EnableAnnotations()` by [@​jgarciadelanoceda](https://togithub.com/jgarciadelanoceda) in [domaindrivendev/Swashbuckle.AspNetCore#2962 - Fix `RequestBodyFilterAnnotation` and `MultipleFromForm` for Minimal APIs by [@​jgarciadelanoceda](https://togithub.com/jgarciadelanoceda) in [domaindrivendev/Swashbuckle.AspNetCore#2963 - Swagger UI refactoring by [@​martincostello](https://togithub.com/martincostello) in [domaindrivendev/Swashbuckle.AspNetCore#2942 - Add help wanted badge by [@​martincostello](https://togithub.com/martincostello) in [domaindrivendev/Swashbuckle.AspNetCore#2911 - Move inline css and js to external files for SwaggerUI and ReDoc by [@​junior-santana](https://togithub.com/junior-santana) in [domaindrivendev/Swashbuckle.AspNetCore#2965 - Missing properties section when generating `IFomFile`/`IFormFileCollection` by [@​jgarciadelanoceda](https://togithub.com/jgarciadelanoceda) in [domaindrivendev/Swashbuckle.AspNetCore#2972 - Missing Encoding and RequiredProperties when `IFormFile` with OpenAPI by [@​jgarciadelanoceda](https://togithub.com/jgarciadelanoceda) in [domaindrivendev/Swashbuckle.AspNetCore#2979 - Use `ApiParameter.Type` by [@​jgarciadelanoceda](https://togithub.com/jgarciadelanoceda) in [domaindrivendev/Swashbuckle.AspNetCore#2980 - Document arrays of generic parameters with XML comments and support overload methods by [@​jgarciadelanoceda](https://togithub.com/jgarciadelanoceda) in [domaindrivendev/Swashbuckle.AspNetCore#2982 - Take into account \[JsonRequired] for System.Text.Json by [@​jgarciadelanoceda](https://togithub.com/jgarciadelanoceda) in [domaindrivendev/Swashbuckle.AspNetCore#2988 - Configure non-nullable types as required by [@​AntiGuideAkquinet](https://togithub.com/AntiGuideAkquinet) in [domaindrivendev/Swashbuckle.AspNetCore#2803 - Use `HttpMethods.IsGet()` by [@​martincostello](https://togithub.com/martincostello) in [domaindrivendev/Swashbuckle.AspNetCore#2971 #### New Contributors - [@​mag1art](https://togithub.com/mag1art) made their first contribution in [domaindrivendev/Swashbuckle.AspNetCore#2908 - [@​jgarciadelanoceda](https://togithub.com/jgarciadelanoceda) made their first contribution in [domaindrivendev/Swashbuckle.AspNetCore#2928 - [@​matt-lethargic](https://togithub.com/matt-lethargic) made their first contribution in [domaindrivendev/Swashbuckle.AspNetCore#2927 - [@​mauve](https://togithub.com/mauve) made their first contribution in [domaindrivendev/Swashbuckle.AspNetCore#2938 - [@​junior-santana](https://togithub.com/junior-santana) made their first contribution in [domaindrivendev/Swashbuckle.AspNetCore#2965 - [@​AntiGuideAkquinet](https://togithub.com/AntiGuideAkquinet) made their first contribution in [domaindrivendev/Swashbuckle.AspNetCore#2803 **Full Changelog**: domaindrivendev/Swashbuckle.AspNetCore@v6.6.2...v6.7.0 </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 is behind base branch, 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 was generated by [Mend Renovate](https://mend.io/renovate/). View the [repository job log](https://developer.mend.io/github/smartive/cas-fee-adv-mumble-api). <!--renovate-debug:eyJjcmVhdGVkSW5WZXIiOiIzNy40NDAuNyIsInVwZGF0ZWRJblZlciI6IjM4LjU2LjAiLCJ0YXJnZXRCcmFuY2giOiJtYWluIiwibGFiZWxzIjpbImRlcGVuZGVuY2llcyJdfQ==--> Co-authored-by: renovate[bot] <29139614+renovate[bot]@users.noreply.github.com>
This PR fixes #1685.
I do not know if it's a SwaggerUi Bug, because this PR only copies the Description that was obtained in the SchemaFilter to the Parameters section. If the description is not showed under every parameter of the operation then the SwaggerUi does not show it.
Anyway, the solution I gave in the issue is very simple, so if you do not see this addition a built in you can close the PR