Document arrays of GenericParameters with XmlComments and support Overload methods #2982

jgarciadelanoceda · 2024-07-14T15:11:16Z

It fixes an issue found while analyzing #2655

I am hesitant to fix the other issue found (When there are 2 methods on a Controller with the same number of parameters and the same name, because you will have to make assumptions here. The base class has to has the firstParameter as TResource and do not have more parameters.. Because I tried to do the following:

But it seems extremelly over complicated and I do not like it very much, the issue is that the XML only has the comments for the baseClass and when searching for the Method, SwashBuckle is searching by the Name, and the number of parameters inside the file MethodInfoExtensions

codecov-commenter · 2024-07-14T15:14:06Z

⚠️ Please install the to ensure uploads and comments are reliably processed by Codecov.

Codecov Report

Attention: Patch coverage is 98.30508% with 1 line in your changes missing coverage. Please review.

Project coverage is 90.66%. Comparing base (3330982) to head (cfdd5e9).
Report is 1 commits behind head on master.

Files	Patch %	Lines
...ore.SwaggerGen/XmlComments/MethodInfoExtensions.cs	98.24%	1 Missing ⚠️

❗ Your organization needs to install the Codecov GitHub app to enable full functionality.

Additional details and impacted files

@@            Coverage Diff             @@
##           master    #2982      +/-   ##
==========================================
+ Coverage   90.51%   90.66%   +0.14%     
==========================================
  Files          74       74              
  Lines        2890     2946      +56     
  Branches      455      468      +13     
==========================================
+ Hits         2616     2671      +55     
- Misses        274      275       +1

Flag	Coverage Δ
Linux	`90.66% <98.30%> (+0.14%)`	⬆️
Windows	`90.66% <98.30%> (+0.14%)`	⬆️
macOS	`90.66% <98.30%> (+0.14%)`	⬆️

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.

jgarciadelanoceda · 2024-07-14T16:50:28Z

Finally I added support for Overload methods and test it with the IntegrationTests, need to fix them

...rnsValidSwaggerJson_startupType=GenericControllers.Startup_swaggerRequestUri=v1.verified.txt

src/Swashbuckle.AspNetCore.SwaggerGen/XmlComments/MethodInfoExtensions.cs

jgarciadelanoceda · 2024-07-17T07:47:23Z

The requested test were created

test/Swashbuckle.AspNetCore.SwaggerGen.Test/Fixtures/FakeGenericResourceController.cs

test/Swashbuckle.AspNetCore.SwaggerGen.Test/XmlComments/XmlMethodInfoExtensionsTests.cs

test/Swashbuckle.AspNetCore.SwaggerGen.Test/Fixtures/FakeGenericResourceController.cs

test/Swashbuckle.AspNetCore.SwaggerGen.Test/XmlComments/XmlMethodInfoExtensionsTests.cs

Co-authored-by: Martin Costello <martin@martincostello.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://github.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://github.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://github.com/mag1art) in [domaindrivendev/Swashbuckle.AspNetCore#2908 - Add `IncludeXmlCommentsForAssembly()` convience overload by [@leotsarev](https://github.com/leotsarev) in [domaindrivendev/Swashbuckle.AspNetCore#2909 - Add snapshot tests using Verify by [@keahpeters](https://github.com/keahpeters) in [domaindrivendev/Swashbuckle.AspNetCore#2929 - Add posibility to ignore properties in `[FromForm]` with `[SwaggerIgnore]` by [@jgarciadelanoceda](https://github.com/jgarciadelanoceda) in [domaindrivendev/Swashbuckle.AspNetCore#2928 - Adding check for existing directory and creating if doesn't exist by [@matt-lethargic](https://github.com/matt-lethargic) in [domaindrivendev/Swashbuckle.AspNetCore#2927 - Default null value on nullable types caused errors by [@jgarciadelanoceda](https://github.com/jgarciadelanoceda) in [domaindrivendev/Swashbuckle.AspNetCore#2941 - Add additional Verify tests by [@keahpeters](https://github.com/keahpeters) in [domaindrivendev/Swashbuckle.AspNetCore#2950 - Only apply a SchemaFilter to create the description on SwaggerUI by [@jgarciadelanoceda](https://github.com/jgarciadelanoceda) in [domaindrivendev/Swashbuckle.AspNetCore#2943 - Add support for async filters by [@mauve](https://github.com/mauve) in [domaindrivendev/Swashbuckle.AspNetCore#2938 - Fix package validation by [@martincostello](https://github.com/martincostello) in [domaindrivendev/Swashbuckle.AspNetCore#2926 - Adding support for .NET 8 Model State attributes by [@jgarciadelanoceda](https://github.com/jgarciadelanoceda) in [domaindrivendev/Swashbuckle.AspNetCore#2958 - Only set Exclusive Range when they are by [@jgarciadelanoceda](https://github.com/jgarciadelanoceda) in [domaindrivendev/Swashbuckle.AspNetCore#2960 - `[AsParameters]` throwing error on cast when showing the description with `EnableAnnotations()` by [@jgarciadelanoceda](https://github.com/jgarciadelanoceda) in [domaindrivendev/Swashbuckle.AspNetCore#2962 - Fix `RequestBodyFilterAnnotation` and `MultipleFromForm` for Minimal APIs by [@jgarciadelanoceda](https://github.com/jgarciadelanoceda) in [domaindrivendev/Swashbuckle.AspNetCore#2963 - Swagger UI refactoring by [@martincostello](https://github.com/martincostello) in [domaindrivendev/Swashbuckle.AspNetCore#2942 - Add help wanted badge by [@martincostello](https://github.com/martincostello) in [domaindrivendev/Swashbuckle.AspNetCore#2911 - Move inline css and js to external files for SwaggerUI and ReDoc by [@junior-santana](https://github.com/junior-santana) in [domaindrivendev/Swashbuckle.AspNetCore#2965 - Missing properties section when generating `IFomFile`/`IFormFileCollection` by [@jgarciadelanoceda](https://github.com/jgarciadelanoceda) in [domaindrivendev/Swashbuckle.AspNetCore#2972 - Missing Encoding and RequiredProperties when `IFormFile` with OpenAPI by [@jgarciadelanoceda](https://github.com/jgarciadelanoceda) in [domaindrivendev/Swashbuckle.AspNetCore#2979 - Use `ApiParameter.Type` by [@jgarciadelanoceda](https://github.com/jgarciadelanoceda) in [domaindrivendev/Swashbuckle.AspNetCore#2980 - Document arrays of generic parameters with XML comments and support overload methods by [@jgarciadelanoceda](https://github.com/jgarciadelanoceda) in [domaindrivendev/Swashbuckle.AspNetCore#2982 - Take into account \[JsonRequired] for System.Text.Json by [@jgarciadelanoceda](https://github.com/jgarciadelanoceda) in [domaindrivendev/Swashbuckle.AspNetCore#2988 - Configure non-nullable types as required by [@AntiGuideAkquinet](https://github.com/AntiGuideAkquinet) in [domaindrivendev/Swashbuckle.AspNetCore#2803 - Use `HttpMethods.IsGet()` by [@martincostello](https://github.com/martincostello) in [domaindrivendev/Swashbuckle.AspNetCore#2971 ##### New Contributors - [@mag1art](https://github.com/mag1art) made their first contribution in [domaindrivendev/Swashbuckle.AspNetCore#2908 - [@jgarciadelanoceda](https://github.com/jgarciadelanoceda) made their first contribution in [domaindrivendev/Swashbuckle.AspNetCore#2928 - [@matt-lethargic](https://github.com/matt-lethargic) made their first contribution in [domaindrivendev/Swashbuckle.AspNetCore#2927 - [@mauve](https://github.com/mauve) made their first contribution in [domaindrivendev/Swashbuckle.AspNetCore#2938 - [@junior-santana](https://github.com/junior-santana) made their first contribution in [domaindrivendev/Swashbuckle.AspNetCore#2965 - [@AntiGuideAkquinet](https://github.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. --- - [ ] 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).  Co-authored-by: renovate[bot] <29139614+renovate[bot]@users.noreply.github.com>

Document arrays of GenericParameters with XmlComments

0b67d44

jgarciadelanoceda marked this pull request as draft July 14, 2024 16:02

Overload methods with the same number of parameters

d7d5019

jgarciadelanoceda marked this pull request as ready for review July 14, 2024 16:49

Fix IntegrationTests

f6c5f92

jgarciadelanoceda changed the title ~~Document arrays of GenericParameters with XmlComments~~ Document arrays of GenericParameters with XmlComments and support Overload methods Jul 15, 2024

martincostello reviewed Jul 15, 2024

View reviewed changes

Javier García de la Noceda Argüelles added 5 commits July 15, 2024 17:38

PR comments on typos and spaces

0e8c24c

Do not calculate constructedTypeParameters in Linq method

d476491

UnitTest for MethodInfoExtensions

4dcb99b

Add more test on MethodInfoExtensions

3154256

Fix issue with IEnumerable<T> and List<T>

1671a31

martincostello reviewed Jul 17, 2024

View reviewed changes

PR comments on test of GetUnderlyingGenericTypeMethod

110bc57

martincostello reviewed Jul 17, 2024

View reviewed changes

Javier García de la Noceda Argüelles added 3 commits July 17, 2024 12:41

Assert.NotNull on several parameters

ed1d58c

PR suggestions

723f812

TheoryData with more information

1ac66a7

martincostello reviewed Jul 17, 2024

View reviewed changes

test/Swashbuckle.AspNetCore.SwaggerGen.Test/XmlComments/XmlMethodInfoExtensionsTests.cs Outdated Show resolved Hide resolved

Javier García de la Noceda Argüelles added 3 commits July 17, 2024 14:00

Avoid using Tuples with TheoryData

fdc7385

Fix commented code

d99a648

expectedReturnType renamed

9fc8dbe

martincostello reviewed Jul 17, 2024

View reviewed changes

Apply suggestions from code review

cfdd5e9

Co-authored-by: Martin Costello <martin@martincostello.com>

martincostello added this to the v6.7.0 milestone Jul 17, 2024

martincostello approved these changes Jul 17, 2024

View reviewed changes

martincostello enabled auto-merge (squash) July 17, 2024 12:25

martincostello merged commit fdb7d6b into domaindrivendev:master Jul 17, 2024
9 checks passed

jgarciadelanoceda deleted the issue_2655_ArrayOfGenericParameterNotDocumented branch July 17, 2024 12:29

renovate bot mentioned this pull request Sep 12, 2024

chore(deps): update nuget non-major dependencies Altinn/app-template-dotnet#211

Open

1 task

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Document arrays of GenericParameters with XmlComments and support Overload methods #2982

Document arrays of GenericParameters with XmlComments and support Overload methods #2982

jgarciadelanoceda commented Jul 14, 2024 •

edited

Loading

codecov-commenter commented Jul 14, 2024 •

edited

Loading

jgarciadelanoceda commented Jul 14, 2024 •

edited

Loading

jgarciadelanoceda commented Jul 17, 2024

Document arrays of GenericParameters with XmlComments and support Overload methods #2982

Document arrays of GenericParameters with XmlComments and support Overload methods #2982

Conversation

jgarciadelanoceda commented Jul 14, 2024 • edited Loading

codecov-commenter commented Jul 14, 2024 • edited Loading

Codecov Report

jgarciadelanoceda commented Jul 14, 2024 • edited Loading

jgarciadelanoceda commented Jul 17, 2024

jgarciadelanoceda commented Jul 14, 2024 •

edited

Loading

codecov-commenter commented Jul 14, 2024 •

edited

Loading

jgarciadelanoceda commented Jul 14, 2024 •

edited

Loading