Fix nullExamples by jgarciadelanoceda · Pull Request #3803 · domaindrivendev/Swashbuckle.AspNetCore

jgarciadelanoceda · 2026-02-18T22:37:06Z

Fixes #3801.
As previously the null was being always serialized and also keep compatibility with not nullable references

As the integer/double could be always have the nullableReference because the objects where int?,double? for old versions seems fine.
I also tought about the object case, that for projects that do not have the nullable references enabled seems OK to me to have that case and also for the case of strings.. I do not really know if I should also place an specific case for arrays

codecov · 2026-02-18T23:12:13Z

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 94.92%. Comparing base (8ad6682) to head (357931c).
⚠️ Report is 29 commits behind head on master.

Additional details and impacted files

@@            Coverage Diff             @@
##           master    #3803      +/-   ##
==========================================
- Coverage   94.93%   94.92%   -0.01%     
==========================================
  Files         111      111              
  Lines        3886     3885       -1     
  Branches      784      783       -1     
==========================================
- Hits         3689     3688       -1     
  Misses        197      197

Flag	Coverage Δ
Linux	`94.92% <100.00%> (-0.01%)`	⬇️
Windows	`94.92% <100.00%> (-0.01%)`	⬇️
macOS	`94.92% <100.00%> (-0.01%)`	⬇️

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.

🚀 New features to boost your workflow:

📦 JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.

…t serialized

jgarciadelanoceda · 2026-02-19T17:13:24Z

@martincostello could you review this?, I think that there is an extra property that is the format that is right now no neccesary but I did at the first implementation needed(I could remove it by the wat)

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

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

Co-authored-by: dldl-cmd <[email protected]>

martincostello · 2026-02-19T17:46:05Z

could you review this?

I see all issues, PRs and comments in this repo - I get to stuff when it fits into my day and my TODO/priority list 😃

Co-authored-by: dldl-cmd <[email protected]>

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

…xampleHelper.cs

martincostello

FYI I'm going to be away next week, so even if this PR is approved/merged today, any new version won't ship until after I'm back as this is already the third attempt at resolving the underlying issue and I don't want a fourth attempt looming while I'm away 😄

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

...Endpoint_ReturnsValidSwaggerJson_startupType=Basic.Startup_swaggerRequestUri=v1.verified.txt

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

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

… not nullable example

… null

martincostello

Could we add an integration test for this too?

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

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

Co-authored-by: Martin Costello <[email protected]>

martincostello · 2026-03-04T14:04:34Z

Once there's some user feedback that this looks right (just to avoid too many releases trying to fix this bug) then can look at merging.

Seems reasonable to me.

Updated [Serilog.AspNetCore](https://github.com/serilog/serilog-aspnetcore) from 9.0.0 to 10.0.0. <details> <summary>Release notes</summary> _Sourced from [Serilog.AspNetCore's releases](https://github.com/serilog/serilog-aspnetcore/releases)._ ## 10.0.0 ## What's Changed * Update deprecated NuGet packages Microsoft.AspNetCore.* by @adamashton in serilog/serilog-aspnetcore#399 * Update to .NET 10 SDK and dependencies by @nblumhardt in serilog/serilog-aspnetcore#401 ## New Contributors * @adamashton made their first contribution in serilog/serilog-aspnetcore#399 **Full Changelog**: serilog/serilog-aspnetcore@v9.0.0...v10.0.0 Commits viewable in [compare view](serilog/serilog-aspnetcore@v9.0.0...v10.0.0). </details> Updated [Serilog.Settings.Configuration](https://github.com/serilog/serilog-settings-configuration) from 9.0.0 to 10.0.0. <details> <summary>Release notes</summary> _Sourced from [Serilog.Settings.Configuration's releases](https://github.com/serilog/serilog-settings-configuration/releases)._ ## 10.0.0 ## What's Changed * Cleanup the TestApp files by @0xced in serilog/serilog-settings-configuration#449 * Fix typo in destructuring policy description by @grinn in serilog/serilog-settings-configuration#460 * Update to `net10.0` SDK and dependencies by @nblumhardt in serilog/serilog-settings-configuration#462 * Remove `FluentAssertions` by @nblumhardt in serilog/serilog-settings-configuration#464 ## New Contributors * @grinn made their first contribution in serilog/serilog-settings-configuration#460 **Full Changelog**: serilog/serilog-settings-configuration@v9.0.0...v10.0.0 Commits viewable in [compare view](serilog/serilog-settings-configuration@v9.0.0...v10.0.0). </details> Updated [Serilog.Sinks.Console](https://github.com/serilog/serilog-sinks-console) from 6.0.0 to 6.1.1. <details> <summary>Release notes</summary> _Sourced from [Serilog.Sinks.Console's releases](https://github.com/serilog/serilog-sinks-console/releases)._ ## 6.1.1 ## What's Changed * Report the number of escape characters formatted into themed sequence rendering by @nblumhardt in serilog/serilog-sinks-console#136 **Full Changelog**: serilog/serilog-sinks-console@v6.1.0...v6.1.1 ## 6.1.0 * #165 - support for `{UtcTimestamp}` in output templates (@ManuelRin) * #172, #173 - switch build to Serilog org standard (@nblumhardt) Commits viewable in [compare view](serilog/serilog-sinks-console@v6.0.0...v6.1.1). </details> Updated [Serilog.Sinks.File](https://github.com/serilog/serilog-sinks-file) from 6.0.0 to 7.0.0. <details> <summary>Release notes</summary> _Sourced from [Serilog.Sinks.File's releases](https://github.com/serilog/serilog-sinks-file/releases)._ ## 7.0.0 ## What's Changed * Fix issue with force-reopen after 30 minutes by @Falco20019 in serilog/serilog-sinks-file#337 * Support `ILoggingFailureListener` by @nblumhardt in serilog/serilog-sinks-file#342 ## New Contributors * @Falco20019 made their first contribution in serilog/serilog-sinks-file#337 **Full Changelog**: serilog/serilog-sinks-file@v4.1.0...v7.0.0 Commits viewable in [compare view](serilog/serilog-sinks-file@v6.0.0...v7.0.0). </details> Updated [Swashbuckle.AspNetCore](https://github.com/domaindrivendev/Swashbuckle.AspNetCore) from 10.1.4 to 10.1.5. <details> <summary>Release notes</summary> _Sourced from [Swashbuckle.AspNetCore's releases](https://github.com/domaindrivendev/Swashbuckle.AspNetCore/releases)._ ## 10.1.5 ## What's Changed * Bump swagger-ui-dist from 5.31.1 to 5.32.0 in /src/Swashbuckle.AspNetCore.SwaggerUI by @dependabot in domaindrivendev/Swashbuckle.AspNetCore#3814 * Migrate to actions/attest by @martincostello in domaindrivendev/Swashbuckle.AspNetCore#3815 * Disable secrets-outside-env audit by @martincostello in domaindrivendev/Swashbuckle.AspNetCore#3823 * Update zizmor to 1.23.1 by @martincostello in domaindrivendev/Swashbuckle.AspNetCore#3825 * Fix null examples by @jgarciadelanoceda in domaindrivendev/Swashbuckle.AspNetCore#3803 * Bump dependencies by @martincostello in domaindrivendev/Swashbuckle.AspNetCore#3835 **Full Changelog**: domaindrivendev/Swashbuckle.AspNetCore@v10.1.4...v10.1.5 Commits viewable in [compare view](domaindrivendev/Swashbuckle.AspNetCore@v10.1.4...v10.1.5). </details> Dependabot will resolve any conflicts with this PR as long as you don't alter it yourself. You can also trigger a rebase manually by commenting `@dependabot rebase`. [//]: # (dependabot-automerge-start) [//]: # (dependabot-automerge-end) --- <details> <summary>Dependabot commands and options</summary> <br /> You can trigger Dependabot actions by commenting on this PR: - `@dependabot rebase` will rebase this PR - `@dependabot recreate` will recreate this PR, overwriting any edits that have been made to it - `@dependabot show <dependency name> ignore conditions` will show all of the ignore conditions of the specified dependency - `@dependabot ignore <dependency name> major version` will close this group update PR and stop Dependabot creating any more for the specific dependency's major version (unless you unignore this specific dependency's major version or upgrade to it yourself) - `@dependabot ignore <dependency name> minor version` will close this group update PR and stop Dependabot creating any more for the specific dependency's minor version (unless you unignore this specific dependency's minor version or upgrade to it yourself) - `@dependabot ignore <dependency name>` will close this group update PR and stop Dependabot creating any more for the specific dependency (unless you unignore this specific dependency or upgrade to it yourself) - `@dependabot unignore <dependency name>` will remove all of the ignore conditions of the specified dependency - `@dependabot unignore <dependency name> <ignore condition>` will remove the ignore condition of the specified dependency and ignore conditions </details> Signed-off-by: dependabot[bot] <[email protected]> Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>

Fix nullExamples

3655980

jgarciadelanoceda mentioned this pull request Feb 18, 2026

Fix null examples being wrongly converted #3802

Closed

Javier García de la Noceda Argüelles added 5 commits February 19, 2026 00:51

Add datetime,dateOnly,Timespan and timeonly to the mix

ec5f792

Brackets

aaddacd

Prevent from nullref

bcc5be8

Feedback from other PR

5e972db

Fix build, the nullable example on verifyTest for string shouldn´t ge…

4f552fa

…t serialized

jgarciadelanoceda marked this pull request as ready for review February 19, 2026 16:42

dldl-cmd suggested changes Feb 19, 2026

View reviewed changes

src/Swashbuckle.AspNetCore.SwaggerGen/XmlComments/XmlCommentsExampleHelper.cs Outdated Show resolved Hide resolved

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

Commit suggestion

e9b4660

Co-authored-by: dldl-cmd <[email protected]>

Make it more readable

1173b75

Co-authored-by: dldl-cmd <[email protected]>

jgarciadelanoceda commented Feb 19, 2026

View reviewed changes

src/Swashbuckle.AspNetCore.SwaggerGen/XmlComments/XmlCommentsExampleHelper.cs Outdated Show resolved Hide resolved

jgarciadelanoceda and others added 6 commits February 19, 2026 18:58

Update src/Swashbuckle.AspNetCore.SwaggerGen/XmlComments/XmlCommentsE…

b3dd727

…xampleHelper.cs

Fix latest suggestions approved

2d2306f

Readability

ff3e529

more readabilty

82dd132

parenthesis

01cf3b1

no need of checking for nullable there

ac6decc

martincostello reviewed Feb 20, 2026

View reviewed changes

Javier García de la Noceda Argüelles added 2 commits February 20, 2026 14:19

fix comments on XML comments and add a test for nullableString with a…

ac64d66

… not nullable example

feedback from PR, put null always not caring about if the type allows…

bea205c

… null

martincostello reviewed Mar 4, 2026

View reviewed changes

martincostello mentioned this pull request Mar 4, 2026

[Bug]: Example Null-Handling Seems Inverted #3801

Closed

Fix PR comments

e7032fd

martincostello reviewed Mar 4, 2026

View reviewed changes

Apply suggestions from code review

357931c

Co-authored-by: Martin Costello <[email protected]>

Uh oh!

Conversation

jgarciadelanoceda commented Feb 18, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

codecov bot commented Feb 18, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Codecov Report

Uh oh!

jgarciadelanoceda commented Feb 19, 2026

Uh oh!

Uh oh!

Uh oh!

martincostello commented Feb 19, 2026

Uh oh!

Uh oh!

martincostello left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

martincostello left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

martincostello commented Mar 4, 2026

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

jgarciadelanoceda commented Feb 18, 2026 •

edited

Loading

codecov bot commented Feb 18, 2026 •

edited

Loading