[CSharp] feat!: add useDateOnly flag (#17471)

* feat: DateOnly for client

* fix: generated doc for csharp

* doc: fix generators README for csharp

* add DateOnly option for aspnet

* refactor: update csharp docs

* refactor: fix typo

* finish

* finish

* finish

* regenerate

* rebuild and regenerate

* fix build error

* finish

* revert path

* regenerate

* remove exceed samples

* regenerate

* add DateOnly to nullable

* remove obsolete file from list

* update test files list

* remove obsolete sample build

* revert manual tests

* revert samples to master and regenerate

* remove new samples

* remove eol

* remove eol

* add new specs

* try fix test

* update tests

* update files

* remove eol

* revert

* remove eol

* regenerate

* add net6+ support to aspnetcore

* add jobs

Author: Anakael

.github/workflows/samples-dotnet.yaml

@@ -4,6 +4,7 @@ on:
   push:
     paths:
       - 'samples/client/petstore/csharp/**net6.0**/'
+      - 'samples/client/petstore/csharp/**net7.0**/'
       - 'samples/client/petstore/csharp/OpenAPIClient-generichost-netcore**/'
       - 'samples/client/petstore/csharp/OpenAPIClient-generichost-manual-tests/**'
       - 'samples/server/petstore/aspnetcore-6.0/**'
@@ -12,6 +13,7 @@ on:
   pull_request:
     paths:
       - 'samples/client/petstore/csharp/**net6.0**/'
+      - 'samples/client/petstore/csharp/**net7.0**/'
       - 'samples/client/petstore/csharp/OpenAPIClient-generichost-netcore**/'
       - 'samples/client/petstore/csharp/OpenAPIClient-generichost-manual-tests/**'
       - 'samples/server/petstore/aspnetcore-6.0/**'
@@ -35,6 +37,8 @@ jobs:
           - samples/client/petstore/csharp/OpenAPIClient-generichost-netcore-latest-oneOf
           - samples/client/petstore/csharp/OpenAPIClient-generichost-netcore-latest-anyOf
           - samples/client/petstore/csharp/OpenAPIClient-generichost-manual-tests
+          - samples/client/petstore/csharp/OpenAPIClient-generichost-net7.0-useDateTimeForDate
+          - samples/client/petstore/csharp/OpenAPIClient-net7.0-useDateTimeForDate
           - samples/server/petstore/aspnetcore-6.0
           - samples/server/petstore/aspnetcore-6.0-pocoModels
           - samples/server/petstore/aspnetcore-6.0-project4Models

bin/configs/csharp-generichost-net7.0-useDateTimeForDate.yaml

@@ -0,0 +1,9 @@
+# for csharp generichost
+generatorName: csharp
+outputDir: samples/client/petstore/csharp/OpenAPIClient-generichost-net7.0-useDateTimeForDate
+inputSpec: modules/openapi-generator/src/test/resources/3_0/csharp/dates-api.yaml
+library: generichost
+templateDir: modules/openapi-generator/src/main/resources/csharp
+additionalProperties:
+  packageGuid: '{2E60EF87-DB0B-4D01-A36E-F5E90F7EC757}'
+  useDateTimeForDate: true

bin/configs/csharp-restsharp-net7.0-useDateTimeForDate.yaml

@@ -0,0 +1,9 @@
+# for .net standard
+generatorName: csharp
+outputDir: samples/client/petstore/csharp/OpenAPIClient-net7.0-useDateTimeForDate
+inputSpec: modules/openapi-generator/src/test/resources/3_0/csharp/dates-api.yaml
+templateDir: modules/openapi-generator/src/main/resources/csharp
+additionalProperties:
+  packageGuid: '{D0A67E81-4061-48EB-B4B8-C73BDF8B2D95}'
+  targetFramework: net7.0
+  useDateTimeForDate: true

docs/generators/README.md

@@ -12,7 +12,7 @@ The following generators are available:
 * [cpp-restsdk](cpp-restsdk.md)  
 * [cpp-tizen](cpp-tizen.md)  
 * [csharp](csharp.md)  
-* [csharp-netcore](csharp-netcore.md)  
+* [csharp-functions](csharp-functions.md)  
 * [dart](dart.md)  
 * [dart-dio](dart-dio.md)  
 * [eiffel](eiffel.md)  

docs/generators/aspnetcore.md

@@ -47,6 +47,7 @@ These options may be applied as additional-properties (cli) or configOptions (pl
 |sourceFolder|source folder for generated code| |src|
 |swashbuckleVersion|Swashbuckle version: 3.0.0 (deprecated), 4.0.0 (deprecated), 5.0.0 (deprecated), 6.4.0|<dl><dt>**3.0.0**</dt><dd>Swashbuckle 3.0.0</dd><dt>**4.0.0**</dt><dd>Swashbuckle 4.0.0</dd><dt>**5.0.0**</dt><dd>Swashbuckle 5.0.0</dd><dt>**6.4.0**</dt><dd>Swashbuckle 6.4.0</dd></dl>|3.0.0|
 |useCollection|Deserialize array types to Collection&lt;T&gt; instead of List&lt;T&gt;.| |false|
+|useDateTimeForDate|Use DateTime to model date properties even if DateOnly supported. (.net 6.0+ only)| |false|
 |useDateTimeOffset|Use DateTimeOffset to model date-time properties| |false|
 |useDefaultRouting|Use default routing for the ASP.NET Core version.| |true|
 |useFrameworkReference|Use frameworkReference for ASP.NET Core 3.0+ and PackageReference ASP.NET Core 2.2 or earlier.| |false|
@@ -74,6 +75,8 @@ These options may be applied as additional-properties (cli) or configOptions (pl
 <ul class="column-ul">
 <li>Boolean</li>
 <li>Collection</li>
+<li>DateOnly</li>
+<li>DateOnly?</li>
 <li>DateTime</li>
 <li>DateTime?</li>
 <li>DateTimeOffset</li>

docs/generators/csharp-functions.md

@@ -44,6 +44,7 @@ These options may be applied as additional-properties (cli) or configOptions (pl
 |sortParamsByRequiredFlag|Sort method arguments to place required parameters before optional parameters.| |true|
 |sourceFolder|source folder for generated code| |src|
 |useCollection|Deserialize array types to Collection<T> instead of List<T>.| |false|
+|useDateTimeForDate|Use DateTime to model date properties even if DateOnly supported. (.net 6.0+ only)| |false|
 |useDateTimeOffset|Use DateTimeOffset to model date-time properties| |false|
 |useNewtonsoft|Uses the Newtonsoft JSON library.| |true|
 
@@ -67,6 +68,8 @@ These options may be applied as additional-properties (cli) or configOptions (pl
 <ul class="column-ul">
 <li>Boolean</li>
 <li>Collection</li>
+<li>DateOnly</li>
+<li>DateOnly?</li>
 <li>DateTime</li>
 <li>DateTime?</li>
 <li>DateTimeOffset</li>

docs/generators/csharp.md

@@ -47,6 +47,7 @@ These options may be applied as additional-properties (cli) or configOptions (pl
 |sourceFolder|source folder for generated code| |src|
 |targetFramework|The target .NET framework version. To target multiple frameworks, use `;` as the separator, e.g. `netstandard2.1;netcoreapp3.1`|<dl><dt>**netstandard1.3**</dt><dd>.NET Standard 1.3</dd><dt>**netstandard1.4**</dt><dd>.NET Standard 1.4</dd><dt>**netstandard1.5**</dt><dd>.NET Standard 1.5</dd><dt>**netstandard1.6**</dt><dd>.NET Standard 1.6</dd><dt>**netstandard2.0**</dt><dd>.NET Standard 2.0</dd><dt>**netstandard2.1**</dt><dd>.NET Standard 2.1</dd><dt>**net47**</dt><dd>.NET Framework 4.7</dd><dt>**net48**</dt><dd>.NET Framework 4.8</dd><dt>**net6.0**</dt><dd>.NET 6.0 (End of Support 12 November 2024)</dd><dt>**net7.0**</dt><dd>.NET 7.0</dd><dt>**net8.0**</dt><dd>.NET 8.0</dd></dl>|net8.0|
 |useCollection|Deserialize array types to Collection&lt;T&gt; instead of List&lt;T&gt;.| |false|
+|useDateTimeForDate|Use DateTime to model date properties even if DateOnly supported. (.net 6.0+ only)| |false|
 |useDateTimeOffset|Use DateTimeOffset to model date-time properties| |false|
 |useOneOfDiscriminatorLookup|Use the discriminator's mapping in oneOf to speed up the model lookup. IMPORTANT: Validation (e.g. one and only one match in oneOf's schemas) will be skipped.| |false|
 |useSourceGeneration|Use source generation where available (only `generichost` library supports this option).| |false|
@@ -73,6 +74,8 @@ These options may be applied as additional-properties (cli) or configOptions (pl
 <ul class="column-ul">
 <li>Boolean</li>
 <li>Collection</li>
+<li>DateOnly</li>
+<li>DateOnly?</li>
 <li>DateTime</li>
 <li>DateTime?</li>
 <li>DateTimeOffset</li>

modules/openapi-generator/src/main/java/org/openapitools/codegen/CodegenConstants.java

@@ -156,6 +156,9 @@ public class CodegenConstants {
     public static final String USE_DATETIME_OFFSET = "useDateTimeOffset";
     public static final String USE_DATETIME_OFFSET_DESC = "Use DateTimeOffset to model date-time properties";
 
+    public static final String USE_DATETIME_FOR_DATE = "useDateTimeForDate";
+    public static final String USE_DATETIME_FOR_DATE_DESC = "Use DateTime to model date properties even if DateOnly supported. (.net 6.0+ only)";
+
     public static final String ENSURE_UNIQUE_PARAMS = "ensureUniqueParams";
     public static final String ENSURE_UNIQUE_PARAMS_DESC = "Whether to ensure parameter names are unique in an operation (rename parameters that are not).";
 

modules/openapi-generator/src/main/java/org/openapitools/codegen/languages/AbstractCSharpCodegen.java

@@ -55,6 +55,7 @@ public abstract class AbstractCSharpCodegen extends DefaultCodegen implements Co
     protected boolean optionalProjectFileFlag = true;
     protected boolean optionalMethodArgumentFlag = true;
     protected boolean useDateTimeOffsetFlag = false;
+    protected boolean useDateTimeForDateFlag = false;
     protected boolean useCollection = false;
     protected boolean returnICollection = false;
     protected boolean netCoreProjectFileFlag = false;
@@ -186,6 +187,8 @@ public AbstractCSharpCodegen() {
                         "DateTime",
                         "DateTimeOffset?",
                         "DateTimeOffset",
+                        "DateOnly?",
+                        "DateOnly",
                         "Boolean",
                         "Double",
                         "Decimal",
@@ -234,6 +237,11 @@ public void useDateTimeOffset(boolean flag) {
         this.setTypeMapping();
     }
 
+    public void useDateTimeForDate(boolean flag) {
+        this.useDateTimeForDateFlag = flag;
+        this.setTypeMapping();
+    }
+
     @Override
     protected void addParentFromContainer(CodegenModel model, Schema schema) {
         // we do not want to inherit simply because additionalProperties is true
@@ -354,6 +362,13 @@ public void processOpts() {
             additionalProperties.put(CodegenConstants.USE_DATETIME_OFFSET, useDateTimeOffsetFlag);
         }
 
+        // {{useDateTimeForDate}}
+        if (additionalProperties.containsKey(CodegenConstants.USE_DATETIME_FOR_DATE)) {
+            useDateTimeForDate(convertPropertyToBooleanAndWriteBack(CodegenConstants.USE_DATETIME_FOR_DATE));
+        } else {
+            additionalProperties.put(CodegenConstants.USE_DATETIME_FOR_DATE, useDateTimeForDateFlag);
+        }
+
         if (additionalProperties.containsKey(CodegenConstants.USE_COLLECTION)) {
             setUseCollection(convertPropertyToBooleanAndWriteBack(CodegenConstants.USE_COLLECTION));
         } else {
@@ -1756,6 +1771,12 @@ protected boolean isValueType(CodegenProperty var) {
         return (this.getValueTypes().contains(var.dataType) || var.isEnum);
     }
 
+    protected boolean useNet60OrLater() { return false; }
+
+    protected boolean useDateOnly() {
+        return useNet60OrLater() && !useDateTimeForDateFlag;
+    }
+
     @Override
     public void setParameterExampleValue(CodegenParameter p) {
         String example;
@@ -1820,16 +1841,18 @@ public void setParameterExampleValue(CodegenParameter p) {
             }
             example = "System.Text.Encoding.ASCII.GetBytes(\"" + escapeText(example) + "\")";
         } else if (p.isDate) {
+            String dateType = typeMapping.get("date");
             if (example == null) {
-                example = "DateTime.Parse(\"2013-10-20\")";
+                example = dateType + ".Parse(\"2013-10-20\")";
             } else {
-                example = "DateTime.Parse(\"" + example + "\")";
+                example = dateType + ".Parse(\"" + example + "\")";
             }
         } else if (p.isDateTime) {
+            String dateType = typeMapping.get("DateTime");
             if (example == null) {
-                example = "DateTime.Parse(\"2013-10-20T19:20:30+01:00\")";
+                example = dateType + ".Parse(\"2013-10-20T19:20:30+01:00\")";
             } else {
-                example = "DateTime.Parse(\"" + example + "\")";
+                example = dateType + ".Parse(\"" + example + "\")";
             }
         } else if (p.isDecimal) {
             if (example == null) {
@@ -1993,7 +2016,7 @@ protected Set<String> getNullableTypes() {
     }
 
     protected Set<String> getValueTypes() {
-        return new HashSet<>(Arrays.asList("decimal", "bool", "int", "uint", "long", "ulong", "float", "double", "DateTime", "DateTimeOffset", "Guid"));
+        return new HashSet<>(Arrays.asList("decimal", "bool", "int", "uint", "long", "ulong", "float", "double", "DateTime", "DateOnly", "DateTimeOffset", "Guid"));
     }
 
     protected void setTypeMapping() {
@@ -2012,7 +2035,7 @@ protected void setTypeMapping() {
         typeMapping.put("decimal", "decimal");
         typeMapping.put("BigDecimal", "decimal");
         typeMapping.put("DateTime", this.useDateTimeOffsetFlag ? "DateTimeOffset" : "DateTime");
-        typeMapping.put("date", "DateTime");
+        typeMapping.put("date", this.useDateOnly() ? "DateOnly" : "DateTime");
         typeMapping.put("file", "System.IO.Stream");
         typeMapping.put("array", "List");
         typeMapping.put("list", "List");

modules/openapi-generator/src/main/java/org/openapitools/codegen/languages/AspNetServerCodegen.java

@@ -52,6 +52,7 @@ public class AspNetServerCodegen extends AbstractCSharpCodegen {
     public static final String BUILD_TARGET = "buildTarget";
     public static final String MODEL_CLASS_MODIFIER = "modelClassModifier";
     public static final String TARGET_FRAMEWORK = "targetFramework";
+    public static final String NET_60_OR_LATER = "net60OrLater";
 
     public static final String PROJECT_SDK = "projectSdk";
     public static final String SDK_WEB = "Microsoft.NET.Sdk.Web";
@@ -209,6 +210,10 @@ public AspNetServerCodegen() {
                 CodegenConstants.USE_DATETIME_OFFSET_DESC,
                 useDateTimeOffsetFlag);
 
+        addSwitch(CodegenConstants.USE_DATETIME_FOR_DATE,
+                CodegenConstants.USE_DATETIME_FOR_DATE_DESC,
+                useDateTimeForDateFlag);
+
         addSwitch(CodegenConstants.USE_COLLECTION,
                 CodegenConstants.USE_COLLECTION_DESC,
                 useCollection);
@@ -299,7 +304,7 @@ public AspNetServerCodegen() {
     @Override
     protected Set<String> getNullableTypes() {
         return new HashSet<>(Arrays.asList("decimal", "bool", "int", "uint", "long", "ulong", "float", "double",
-            "DateTime", "DateTimeOffset", "Guid"));
+            "DateTime", "DateOnly", "DateTimeOffset", "Guid"));
     }
 
     @Override
@@ -462,6 +467,11 @@ public void processOpts() {
         this.setTypeMapping();
     }
 
+    @Override
+    protected boolean useNet60OrLater() {
+        return additionalProperties.containsKey(NET_60_OR_LATER);
+    }
+
     public void setPackageGuid(String packageGuid) {
         this.packageGuid = packageGuid;
     }
@@ -775,6 +785,20 @@ private void setIsFramework() {
             useFrameworkReference = true;
             additionalProperties.put(USE_FRAMEWORK_REFERENCE, useFrameworkReference);
             additionalProperties.put(TARGET_FRAMEWORK, "net6.0");
+        } else if (aspnetCoreVersion.getOptValue().startsWith("7.")) {
+            LOGGER.warn(
+                    "ASP.NET core version is {} so changing to use frameworkReference instead of packageReference ",
+                    aspnetCoreVersion.getOptValue());
+            useFrameworkReference = true;
+            additionalProperties.put(USE_FRAMEWORK_REFERENCE, useFrameworkReference);
+            additionalProperties.put(TARGET_FRAMEWORK, "net7.0");
+        } else if (aspnetCoreVersion.getOptValue().startsWith("8.")) {
+            LOGGER.warn(
+                    "ASP.NET core version is {} so changing to use frameworkReference instead of packageReference ",
+                    aspnetCoreVersion.getOptValue());
+            useFrameworkReference = true;
+            additionalProperties.put(USE_FRAMEWORK_REFERENCE, useFrameworkReference);
+            additionalProperties.put(TARGET_FRAMEWORK, "net8.0");
         } else {
             if (additionalProperties.containsKey(USE_FRAMEWORK_REFERENCE)) {
                 useFrameworkReference = convertPropertyToBooleanAndWriteBack(USE_FRAMEWORK_REFERENCE);
@@ -783,6 +807,17 @@ private void setIsFramework() {
             }
             additionalProperties.put(TARGET_FRAMEWORK, "netcoreapp" + aspnetCoreVersion);
         }
+
+        setAddititonalPropertyForFramework();
+    }
+
+    private void setAddititonalPropertyForFramework() {
+        String targetFramework = ((String)additionalProperties.get(TARGET_FRAMEWORK));
+        if (targetFramework.startsWith("net6.0") ||
+            targetFramework.startsWith("net7.0") || 
+            targetFramework.startsWith("net8.0")) {
+            additionalProperties.put(NET_60_OR_LATER, true);
+        }
     }
 
     private void setUseNewtonsoft() {