Extend built-in supported types #2804

martincostello · 2024-04-16T08:27:32Z

Ensure DateOnly and TimeOnly with for Newtonsoft.Json.
Add System.Text.Json support for TimeSpan and Version.
Add Int128 and UInt128 support.
Handle AnnotationsDataType.Upload.
Create AnnotationsDataType mapping dictionary only once.

Resolves #2611
Relates to #2500

codecov-commenter · 2024-04-16T08:31:21Z

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 92.14%. Comparing base (c936acb) to head (8fab64d).

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

Additional details and impacted files

@@            Coverage Diff             @@
##           master    #2804      +/-   ##
==========================================
+ Coverage   92.10%   92.14%   +0.04%     
==========================================
  Files          91       91              
  Lines        3064     3080      +16     
  Branches      525      526       +1     
==========================================
+ Hits         2822     2838      +16     
  Misses        242      242

Flag	Coverage Δ
Linux	`92.14% <100.00%> (+0.04%)`	⬆️
Windows	`92.14% <100.00%> (+0.04%)`	⬆️
macOS	`92.14% <100.00%> (+0.04%)`	⬆️

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.

- Ensure `DateOnly` and `TimeOnly` with for Newtonsoft.Json. - Add System.Text.Json support for `TimeSpan` and `Version`. - Add Int128 and UInt128 support. - Handle `AnnotationsDataType.Upload`. - Create `AnnotationsDataType` mapping dictionary only once. Resolves domaindrivendev#2611.

- Use `TryGetValue()` instead of `ContainsKey()` and indexer. - Apply some IDE refactoring suggestions.

remcolam · 2024-04-26T13:11:36Z

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

@@ -186,7 +197,7 @@ private IEnumerable<DataProperty> GetDataPropertiesFor(JsonObjectContract jsonOb
            return dataProperties;
        }

-        private static readonly Dictionary<Type, Tuple<DataType, string>> PrimitiveTypesAndFormats = new Dictionary<Type, Tuple<DataType, string>>
+        private static readonly Dictionary<Type, Tuple<DataType, string>> PrimitiveTypesAndFormats = new()


Suggested change

private static readonly Dictionary<Type, Tuple<DataType, string>> PrimitiveTypesAndFormats = new()

private static readonly Dictionary<Type, Tuple<DataType, string>> PrimitiveTypesAndFormats = new

Add test for domaindrivendev#2771 for `DateOnly` values.

vierlijner

Please add a #if NET6_0_OR_GREATER ... #endif (snippet) around the test inline data for dateonly and timeonly in the testfiles, like the example below. I can't suggest this change anymore.
#if NET6_0_OR_GREATER [InlineData(typeof(DateOnly), "string", "date")] [InlineData(typeof(TimeOnly), "string", "time")] #endif

martincostello · 2024-05-10T08:31:52Z

There was no need to do that in the Swashbuckle.AspNetCore.Newtonsoft.Test project because it already targets a minimum of .NET 6 so the condition would always have evaluated to true. The preprocessor condition was added where it was needed.

martincostello added the feature suggestion label Apr 16, 2024

martincostello added 2 commits April 23, 2024 10:19

Use TryGetValue()

8fab64d

- Use `TryGetValue()` instead of `ContainsKey()` and indexer. - Apply some IDE refactoring suggestions.

martincostello force-pushed the extend-type-support branch from 466a55b to 8fab64d Compare April 23, 2024 09:20

martincostello enabled auto-merge (squash) April 25, 2024 06:47

martincostello added this to the v6.6.0 milestone Apr 25, 2024

martincostello mentioned this pull request Apr 25, 2024

DateOnly not rendering correctly in Swagger #2771

Closed

remcolam reviewed Apr 26, 2024

View reviewed changes

martincostello mentioned this pull request May 5, 2024

.Net 6 TimeSpan is generated as schema in OpenAPI document but serialized as "time-span" formatted string #2505

Open

domaindrivendev approved these changes May 6, 2024

View reviewed changes

martincostello merged commit 4d5625f into domaindrivendev:master May 6, 2024
9 checks passed

martincostello deleted the extend-type-support branch May 6, 2024 21:45

martincostello referenced this pull request in martincostello/Swashbuckle.AspNetCore May 8, 2024

Add test for DateOnly

c8596df

Add test for domaindrivendev#2771 for `DateOnly` values.

vierlijner reviewed May 10, 2024

View reviewed changes

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Extend built-in supported types #2804

Extend built-in supported types #2804

martincostello commented Apr 16, 2024 •

edited

codecov-commenter commented Apr 16, 2024 •

edited

remcolam Apr 26, 2024

vierlijner left a comment

martincostello commented May 10, 2024 •

edited

	private static readonly Dictionary<Type, Tuple<DataType, string>> PrimitiveTypesAndFormats = new()
	private static readonly Dictionary<Type, Tuple<DataType, string>> PrimitiveTypesAndFormats = new

Extend built-in supported types #2804

Extend built-in supported types #2804

Conversation

martincostello commented Apr 16, 2024 • edited

codecov-commenter commented Apr 16, 2024 • edited

Codecov Report

remcolam Apr 26, 2024

Choose a reason for hiding this comment

vierlijner left a comment

Choose a reason for hiding this comment

martincostello commented May 10, 2024 • edited

martincostello commented Apr 16, 2024 •

edited

codecov-commenter commented Apr 16, 2024 •

edited

martincostello commented May 10, 2024 •

edited