Configure non-nullable types as required #2803

AntiGuideAkquinet · 2024-04-16T07:35:19Z

This is a contiuation of the work done in PR #2710. It closes #2036. If any changes are necessary I'll gladly add them.

Without this change the setting will not be set when getting SchemaGeneratorOptions from DI in SchemaGenerator

Because of the higher precedence of the && operator compared to the ?? operator we need to prioritize ?? manually with brackets.

codecov-commenter · 2024-04-16T07:40:43Z

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

Codecov Report

Attention: Patch coverage is 85.71429% with 2 lines in your changes missing coverage. Please review.

Project coverage is 90.64%. Comparing base (3553751) to head (61760a4).

Files	Patch %	Lines
...DependencyInjection/SwaggerGenOptionsExtensions.cs	0.00%	2 Missing ⚠️

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

Additional details and impacted files

@@            Coverage Diff             @@
##           master    #2803      +/-   ##
==========================================
- Coverage   90.67%   90.64%   -0.03%     
==========================================
  Files          74       74              
  Lines        2948     2961      +13     
  Branches      468      469       +1     
==========================================
+ Hits         2673     2684      +11     
- Misses        275      277       +2

Flag	Coverage Δ
Linux	`90.64% <85.71%> (-0.03%)`	⬇️
Windows	`90.64% <85.71%> (-0.03%)`	⬇️
macOS	`90.64% <85.71%> (-0.03%)`	⬇️

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.

src/Swashbuckle.AspNetCore.SwaggerGen/DependencyInjection/SwaggerGenOptionsExtensions.cs

src/Swashbuckle.AspNetCore.SwaggerGen/SchemaGenerator/SchemaGenerator.cs

src/Swashbuckle.AspNetCore.SwaggerGen/SchemaGenerator/SchemaGeneratorOptions.cs

...Swashbuckle.AspNetCore.SwaggerGen.Test/SchemaGenerator/JsonSerializerSchemaGeneratorTests.cs

The change is located in SchemaGenerator.CreateObjectSchema.

The new comment true to what is actually done when setting this option.

src/Swashbuckle.AspNetCore.SwaggerGen/SchemaGenerator/SchemaGenerator.cs

AntiGuideAkquinet · 2024-04-19T11:15:02Z

It seems like #2810 implemented the feature in the meantime. Thanks for the feedback on the code tough.

martincostello · 2024-04-19T12:04:20Z

That's a slightly different use case - that's about the required keyword - this change would help for projects not using it, no?

SimonRask · 2024-07-19T13:14:59Z

@martincostello This could indeed be very useful.

@AntiGuideAkquinet If this could be reopened, it would be appreciated. If you don't have time to address potential comments, I would be happy to help out. :)

AntiGuideAkquinet · 2024-07-20T06:46:02Z

@SimonRask I reopened the PR. Thank you for your help!

martincostello · 2024-07-20T13:16:46Z

Thanks for re-opening. If you resolve the merge conflicts I'll take a look.

…tCore

SimonRask · 2024-07-20T17:48:26Z

I have (hopefully correctly) resolved the conflicts in my fork. I don't know if it is easier for me to open a new pull request, or if you can pull the changes into your branch. @AntiGuideAkquinet

AntiGuideAkquinet · 2024-07-23T04:47:18Z

@SimonRask Sure! I invited you as a collaborator on the forked repo that the PR is based on. You should be able to pull your changes in. 🙂

SimonRask · 2024-07-23T05:15:28Z

@martincostello Conflicts should be resolved now :)

src/Swashbuckle.AspNetCore.SwaggerGen/SchemaGenerator/SchemaGenerator.cs

[![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>

blouflashdb and others added 6 commits September 16, 2023 17:00

add schemaoption to configure non-nullable types as required

25fb4e5

fix bad whitespaces

a315fbc

fix another bad whitespace

01690f2

Merge remote-tracking branch 'refs/remotes/origin_pull_to/master'

c0773ce

Add MarkNonNullableReferenceTypesAsRequired to DeepCopy

f97d834

Without this change the setting will not be set when getting SchemaGeneratorOptions from DI in SchemaGenerator

Fix detection on non nullable types to mark as required

646ccee

Because of the higher precedence of the && operator compared to the ?? operator we need to prioritize ?? manually with brackets.

martincostello reviewed Apr 16, 2024

View reviewed changes

martincostello mentioned this pull request Apr 16, 2024

Add public API analysers #2801

Closed

AntiGuideAkquinet added 6 commits April 17, 2024 08:31

Improve naming of (Mark)NonNullableReferenceTypesAsRequired

98afe46

Reorder conditions to improve performance due to lazy evaluation

9034cc0

The change is located in SchemaGenerator.CreateObjectSchema.

Change a comment on NonNullableReferenceTypesAsRequired

767bc7f

The new comment true to what is actually done when setting this option.

Adjust naming of test to reflect changes from 98afe46

80c6c6e

Add parameter on Subject to make MvcOptions testable

73ba147

Add a test for the option to suppress NRT being recognized as required

a3169f8

LUS1N approved these changes Apr 17, 2024

View reviewed changes

Switch MvcOptions on SchemaGenerator to be optional

0dd334d

martincostello reviewed Apr 18, 2024

View reviewed changes

src/Swashbuckle.AspNetCore.SwaggerGen/SchemaGenerator/SchemaGenerator.cs Outdated Show resolved Hide resolved

Prevent binary breaking change in SchemaGenerator

ab58945

AntiGuideAkquinet closed this Apr 19, 2024

AntiGuideAkquinet reopened this Jul 20, 2024

Merge branch 'master' of github.com:domaindrivendev/Swashbuckle.AspNe…

30503ed

…tCore

martincostello reviewed Jul 23, 2024

View reviewed changes

src/Swashbuckle.AspNetCore.SwaggerGen/SchemaGenerator/SchemaGenerator.cs Outdated Show resolved Hide resolved

Change expression ordering

61760a4

martincostello approved these changes Jul 23, 2024

View reviewed changes

martincostello merged commit 85fefe4 into domaindrivendev:master Jul 23, 2024
9 checks passed

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

martincostello mentioned this pull request Aug 1, 2024

[Bug]: Swashbuckle.AspNetCore.Cli v.6.7.0 doesn't generate format of the property #3005

Closed

billhong-just mentioned this pull request Sep 23, 2024

[Feature request]: Generate nullable properties as required #2969

Open

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Configure non-nullable types as required #2803

Configure non-nullable types as required #2803

AntiGuideAkquinet commented Apr 16, 2024

codecov-commenter commented Apr 16, 2024 •

edited

Loading

AntiGuideAkquinet commented Apr 19, 2024

martincostello commented Apr 19, 2024

SimonRask commented Jul 19, 2024

AntiGuideAkquinet commented Jul 20, 2024

martincostello commented Jul 20, 2024

SimonRask commented Jul 20, 2024

AntiGuideAkquinet commented Jul 23, 2024

SimonRask commented Jul 23, 2024

Configure non-nullable types as required #2803

Configure non-nullable types as required #2803

Conversation

AntiGuideAkquinet commented Apr 16, 2024

codecov-commenter commented Apr 16, 2024 • edited Loading

Codecov Report

AntiGuideAkquinet commented Apr 19, 2024

martincostello commented Apr 19, 2024

SimonRask commented Jul 19, 2024

AntiGuideAkquinet commented Jul 20, 2024

martincostello commented Jul 20, 2024

SimonRask commented Jul 20, 2024

AntiGuideAkquinet commented Jul 23, 2024

SimonRask commented Jul 23, 2024

codecov-commenter commented Apr 16, 2024 •

edited

Loading