Add IncludeXmlCommentsForAssembly convience overload #2909
Merged
+36
−16
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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 #2909 +/- ##
==========================================
+ Coverage 89.89% 89.90% +0.01%
==========================================
Files 72 72
Lines 2711 2715 +4
Branches 429 429
==========================================
+ Hits 2437 2441 +4
Misses 274 274
Flags with carried forward coverage won't be shown. Click here to find out more. ☔ View full report in Codecov by Sentry. |
test/Swashbuckle.AspNetCore.SwaggerGen.Test/XmlComments/XmlCommentsDocumentFilterTests.cs
Outdated
Show resolved
Hide resolved
|
What about updating some of the tests and the README to use this? code search |
src/Swashbuckle.AspNetCore.SwaggerGen/DependencyInjection/SwaggerGenOptionsExtensions.cs
Outdated
Show resolved
Hide resolved
leotsarev
force-pushed
the
IncludeXmlCommentsForAssembly
branch
from
5ea3d5e
to
d66ae91
Compare
Updated tests and README |
martincostello
approved these changes
May 18, 2024
Co-authored-by: Martin Costello <martin@martincostello.com>
leotsarev
commented
May 19, 2024
src/Swashbuckle.AspNetCore.SwaggerGen/DependencyInjection/SwaggerGenOptionsExtensions.cs
Show resolved
Hide resolved
|
I don't understand why windows build is failing. Could we restart this to understand if this is some kind of instability? |
WeihanLi
reviewed
Aug 1, 2024
| @@ -539,7 +539,8 @@ To enhance the generated docs with human-friendly descriptions, you can annotate | |||
| ); | |||
|
|
|||
| var filePath = Path.Combine(System.AppContext.BaseDirectory, "MyApi.xml"); | |||
There was a problem hiding this comment.
maybe this line could be removed
renovate bot
added a commit
to orso-co/Orso.Arpa.Api
that referenced
this pull request
Aug 4, 2024
[](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` | [](https://docs.renovatebot.com/merge-confidence/) | [](https://docs.renovatebot.com/merge-confidence/) | [](https://docs.renovatebot.com/merge-confidence/) | [](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>
](https://renovatebot.com){kind=link}
renovate bot
added a commit
to smartive/cas-fee-adv-mumble-api
that referenced
this pull request
Sep 5, 2024
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` | [](https://docs.renovatebot.com/merge-confidence/) | [](https://docs.renovatebot.com/merge-confidence/) | [](https://docs.renovatebot.com/merge-confidence/) | [](https://docs.renovatebot.com/merge-confidence/) | | [Swashbuckle.AspNetCore.Annotations](https://togithub.com/domaindrivendev/Swashbuckle.AspNetCore) | `6.6.2` -> `6.7.3` | [](https://docs.renovatebot.com/merge-confidence/) | [](https://docs.renovatebot.com/merge-confidence/) | [](https://docs.renovatebot.com/merge-confidence/) | [](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>
1 task
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Pull Request
The issue or feature being addressed
Fixed #2750
Details on the issue fix or feature implementation