Fix generation when [DefaultValue]'s type differs #2895

martincostello · 2024-05-15T13:34:31Z

Fix SwaggerGeneratorException if the type of a [DefaultValue] does not match the type of the property when using System.Text.Json for serialization.
Fix schema generation of default values for nullable enums default values.
Resolve some IDE refactoring suggestions.
Render the response if an integration test fails for easier debugging.

Regressions caused by changes in #2800 to avoid serializing object by providing the type to the serializer.

Resolves [Bug]: Exception on start after upgrade to latest #2885
Resolves [Bug]: SwaggerGeneratorException (Failed to generate schema for type - System.Nullable`1[{enum_type}]) when using UseAllOfToExtendedReferenceSchemas #2904

codecov-commenter · 2024-05-16T15:08:28Z

Codecov Report

Attention: Patch coverage is 96.00000% with 1 lines in your changes are missing coverage. Please review.

Project coverage is 90.06%. Comparing base (432c417) to head (dd47198).

Files	Patch %	Lines
...Core.SwaggerGen/SchemaGenerator/SchemaGenerator.cs	93.75%	1 Missing ⚠️

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

Additional details and impacted files

@@            Coverage Diff             @@
##           master    #2895      +/-   ##
==========================================
+ Coverage   89.89%   90.06%   +0.17%     
==========================================
  Files          72       72              
  Lines        2711     2718       +7     
  Branches      429      431       +2     
==========================================
+ Hits         2437     2448      +11     
+ Misses        274      270       -4

Flag	Coverage Δ
Linux	`90.06% <96.00%> (+0.17%)`	⬆️
Windows	`90.06% <96.00%> (+0.17%)`	⬆️
macOS	`90.06% <96.00%> (+0.17%)`	⬆️

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/SchemaGenerator/SchemaGenerator.cs

Fix SwaggerGeneratorException if the type of a `[DefaultValue]` does not match the type of the property when using System.Text.Json for serialization. Resolves domaindrivendev#2885.

- Fix schema generation of default values for nullable enums with System.Text.Json. - Resolve some IDE refactoring suggestions. - Render the response if an integration test fails. Resolves domaindrivendev#2904.

Use the same implementation for coercing the default value to the correct type for both `[DefaultValue]` and default method parameters.

Fix null not being checked for after refactor.

src/Swashbuckle.AspNetCore.Newtonsoft/SchemaGenerator/NewtonsoftDataContractResolver.cs

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

domaindrivendev · 2024-05-21T14:55:32Z

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

@@ -177,7 +184,7 @@ private IEnumerable<DataProperty> GetDataPropertiesFor(Type objectType, out Type

                    return
                        (property.IsPubliclyReadable() || property.IsPubliclyWritable()) &&
-                        !(property.GetIndexParameters().Any()) &&
+                        !(property.GetIndexParameters().Length > 0) &&


@martincostello is this another performance-related suggestion? Personally, I prefer the readability of Any()

Most likely yes. See CA1860

(Note: I also don't like that rule. I've disabled it in my projects since I don't write high performance code.)

Yeah this is a new analyser rule related to performance as well.

domaindrivendev · 2024-05-21T14:56:56Z

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

@@ -292,7 +292,7 @@ private OpenApiSchema CreatePrimitiveSchema(DataContract dataContract)
                schema.Enum = dataContract.EnumValues
                    .Select(value => JsonSerializer.Serialize(value))
                    .Distinct()
-                    .Select(valueAsJson => OpenApiAnyFactory.CreateFromJson(valueAsJson))
+                    .Select(OpenApiAnyFactory.CreateFromJson)


martincostello added the bug fix label May 15, 2024

martincostello added this to the v6.6.2 milestone May 15, 2024

martincostello enabled auto-merge (rebase) May 15, 2024 13:38

martincostello disabled auto-merge May 16, 2024 14:17

martincostello force-pushed the gh-2885 branch from 59c6dd6 to 4d48475 Compare May 16, 2024 14:51

martincostello enabled auto-merge (squash) May 16, 2024 15:35

cremor reviewed May 19, 2024

View reviewed changes

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

martincostello added 3 commits May 19, 2024 13:54

Fix generation when [DefaultValue]'s type differs

cb030a7

Fix SwaggerGeneratorException if the type of a `[DefaultValue]` does not match the type of the property when using System.Text.Json for serialization. Resolves domaindrivendev#2885.

Fix generation for nullable enums

5e22cd0

- Fix schema generation of default values for nullable enums with System.Text.Json. - Resolve some IDE refactoring suggestions. - Render the response if an integration test fails. Resolves domaindrivendev#2904.

Unify implementations

b10358c

Use the same implementation for coercing the default value to the correct type for both `[DefaultValue]` and default method parameters.

martincostello force-pushed the gh-2885 branch from 01cf095 to b10358c Compare May 19, 2024 13:23

Fix null check

dd47198

Fix null not being checked for after refactor.

cremor approved these changes May 19, 2024

View reviewed changes

domaindrivendev reviewed May 21, 2024

View reviewed changes

src/Swashbuckle.AspNetCore.Newtonsoft/SchemaGenerator/NewtonsoftDataContractResolver.cs Show resolved Hide resolved

domaindrivendev reviewed May 21, 2024

View reviewed changes

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

domaindrivendev reviewed May 21, 2024

View reviewed changes

domaindrivendev approved these changes May 21, 2024

View reviewed changes

martincostello merged commit fe87e6d into domaindrivendev:master May 21, 2024
9 checks passed

martincostello deleted the gh-2885 branch May 21, 2024 14:57

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Fix generation when [DefaultValue]'s type differs #2895

Fix generation when [DefaultValue]'s type differs #2895

martincostello commented May 15, 2024 •

edited

Loading

codecov-commenter commented May 16, 2024 •

edited

Loading

domaindrivendev May 21, 2024

cremor May 21, 2024

martincostello May 21, 2024

domaindrivendev May 21, 2024

Fix generation when [DefaultValue]'s type differs #2895

Fix generation when [DefaultValue]'s type differs #2895

Conversation

martincostello commented May 15, 2024 • edited Loading

codecov-commenter commented May 16, 2024 • edited Loading

Codecov Report

domaindrivendev May 21, 2024

Choose a reason for hiding this comment

cremor May 21, 2024

Choose a reason for hiding this comment

martincostello May 21, 2024

Choose a reason for hiding this comment

domaindrivendev May 21, 2024

Choose a reason for hiding this comment

martincostello commented May 15, 2024 •

edited

Loading

codecov-commenter commented May 16, 2024 •

edited

Loading