Merge remote-tracking branch 'origin/master' into fix_cli_display

Conflicts:
	bin/utils/ensure-up-to-date

.github/PULL_REQUEST_TEMPLATE.md

@@ -2,7 +2,7 @@
 
 - [ ] Read the [contribution guidelines](https://github.com/openapitools/openapi-generator/blob/master/CONTRIBUTING.md).
 - [ ] Ran the shell script under `./bin/` to update Petstore sample so that CIs can verify the change. (For instance, only need to run `./bin/{LANG}-petstore.sh` and `./bin/security/{LANG}-petstore.sh` if updating the {LANG} (e.g. php, ruby, python, etc) code generator or {LANG} client's mustache templates). Windows batch files can be found in `.\bin\windows\`.
-- [ ] Filed the PR against the [correct branch](https://github.com/OpenAPITools/openapi-generator/wiki/Git-Branches): `master`, `4.0.x`. Default: `master`.
+- [ ] Filed the PR against the [correct branch](https://github.com/OpenAPITools/openapi-generator/wiki/Git-Branches): `master`, `3.3.x`, `4.0.x`. Default: `master`.
 - [ ] Copied the [technical committee](https://github.com/openapitools/openapi-generator/#62---openapi-generator-technical-committee) to review the pull request if your PR is targeting a particular programming language.
 
 ### Description of the PR

appveyor.yml

@@ -35,13 +35,19 @@ build_script:
   # install openapi-generator locally
   - mvn clean install --quiet
 test_script:
+  # restore test-related files
+  - copy /b/v/y CI\samples.ci\client\petstore\csharp\OpenAPIClient\src\Org.OpenAPITools.Test\Org.OpenAPITools.Test.csproj samples\client\petstore\csharp\OpenAPIClient\src\Org.OpenAPITools.Test\Org.OpenAPITools.Test.csproj
   # test c# API client
   - nunit-console samples\client\petstore\csharp\OpenAPIClient\src\Org.OpenAPITools.Test\bin\Debug\Org.OpenAPITools.Test.dll --result=myresults.xml;format=AppVeyor
   # test c# API client (with PropertyChanged)
   - nunit-console samples\client\petstore\csharp\OpenAPIClientWithPropertyChanged\src\Org.OpenAPITools.Test\bin\Debug\Org.OpenAPITools.Test.dll --result=myresults.xml;format=AppVeyor
 
   # generate all petstore clients
   - .\bin\windows\run-all-petstore.cmd
+
+  # generate all petstore clients (openapi3)
+  - .\bin\openapi3\windows\run-all-petstore.cmd
+
 cache:
   - C:\maven\
   - C:\Users\appveyor\.m2

bin/csharp-petstore.sh

@@ -29,8 +29,9 @@ fi
 export JAVA_OPTS="${JAVA_OPTS} -XX:MaxPermSize=256M -Xmx1024M -DloggerPath=conf/log4j.properties"
 ags="generate -i modules/openapi-generator/src/test/resources/2_0/petstore-with-fake-endpoints-models-for-testing.yaml -g csharp -o samples/client/petstore/csharp/OpenAPIClient --additional-properties packageGuid={321C8C3F-0156-40C1-AE42-D59761FB9B6C} $@"
 
+java $JAVA_OPTS -jar $executable $ags
+
 # restore csproj file
 echo "restore csproject file: CI/samples/client/petstore/csharp/OpenAPIClient/src/Org.OpenAPITools.Test/Org.OpenAPITools.Test.csproj"
-cp ./CI/samples/client/petstore/csharp/OpenAPIClient/src/Org.OpenAPITools.Test/Org.OpenAPITools.Test.csproj ./samples/client/petstore/csharp/OpenAPIClient/src/Org.OpenAPITools.Test/
+cp ./CI/samples.ci/client/petstore/csharp/OpenAPIClient/src/Org.OpenAPITools.Test/Org.OpenAPITools.Test.csproj ./samples/client/petstore/csharp/OpenAPIClient/src/Org.OpenAPITools.Test/
 
-java $JAVA_OPTS -jar $executable $ags

bin/dynamic-html.sh

@@ -27,6 +27,6 @@ fi
 
 # if you've executed sbt assembly previously it will use that instead.
 export JAVA_OPTS="${JAVA_OPTS} -XX:MaxPermSize=256M -Xmx1024M -DloggerPath=conf/log4j.properties"
-ags="generate -i modules/openapi-generator/src/test/resources/2_0/petstore.yaml -g dynamic-html  -o samples/dynamic-html $@"
+ags="generate -i modules/openapi-generator/src/test/resources/2_0/petstore.yaml -g dynamic-html  -o samples/documentation/dynamic-html $@"
 
 java $JAVA_OPTS -jar $executable $ags

bin/html-markdown.sh

@@ -27,6 +27,6 @@ fi
 
 # if you've executed sbt assembly previously it will use that instead.
 export JAVA_OPTS="${JAVA_OPTS} -XX:MaxPermSize=256M -Xmx1024M -DloggerPath=conf/log4j.properties"
-ags="generate -i modules/openapi-generator/src/test/resources/2_0/markdown.yaml -g html  -o samples/html.md $@"
+ags="generate -i modules/openapi-generator/src/test/resources/2_0/markdown.yaml -g html  -o samples/documentation/html.md $@"
 
 java $JAVA_OPTS -jar $executable $ags

bin/html-petstore.sh

@@ -27,6 +27,6 @@ fi
 
 # if you've executed sbt assembly previously it will use that instead.
 export JAVA_OPTS="${JAVA_OPTS} -XX:MaxPermSize=256M -Xmx1024M -DloggerPath=conf/log4j.properties"
-ags="generate -i modules/openapi-generator/src/test/resources/2_0/petstore.yaml -g html  -o samples/html $@"
+ags="generate -i modules/openapi-generator/src/test/resources/2_0/petstore.yaml -g html  -o samples/documentation/html $@"
 
 java $JAVA_OPTS -jar $executable $ags

bin/html2-petstore.sh

@@ -27,6 +27,6 @@ fi
 
 # if you've executed sbt assembly previously it will use that instead.
 export JAVA_OPTS="${JAVA_OPTS} -XX:MaxPermSize=256M -Xmx1024M -DloggerPath=conf/log4j.properties"
-ags="generate -i modules/openapi-generator/src/test/resources/2_0/petstore.yaml -g html2  -o samples/html2 --additional-properties hideGenerationTimestamp=true $@"
+ags="generate -i modules/openapi-generator/src/test/resources/2_0/petstore.yaml -g html2  -o samples/documentation/html2 --additional-properties hideGenerationTimestamp=true $@"
 
 java $JAVA_OPTS -jar $executable $ags

bin/openapi3/csharp-petstore.sh

@@ -27,6 +27,6 @@ fi
 
 # if you've executed sbt assembly previously it will use that instead.
 export JAVA_OPTS="${JAVA_OPTS} -XX:MaxPermSize=256M -Xmx1024M -DloggerPath=conf/log4j.properties"
-ags="generate $@ -i modules/openapi-generator/src/test/resources/3_0/petstore-with-fake-endpoints-models-for-testing.yaml -g csharp -o samples/client/petstore/csharp/OpenAPIClient --additional-properties packageGuid={321C8C3F-0156-40C1-AE42-D59761FB9B6C}"
+ags="generate $@ -i modules/openapi-generator/src/test/resources/3_0/petstore-with-fake-endpoints-models-for-testing.yaml -g csharp -o samples/openapi3/client/petstore/csharp/OpenAPIClient --additional-properties packageGuid={321C8C3F-0156-40C1-AE42-D59761FB9B6C}"
 
 java $JAVA_OPTS -jar $executable $ags

bin/openapi3/run-all-petstore

@@ -0,0 +1,33 @@
+#!/bin/bash
+# this bash script will loop through all the .sh files under bin
+# execute the script and check the result (exit code) to see if
+# there's any error
+
+echo "IMPORTANT: this script should be run by the CI (e.g. Shippable) only. There's no need to run this script to update Petstore samples for all generators."
+echo "Please press CTRL+C to stop or the script will continue in 10 seconds."
+
+sleep 10
+
+successes=0
+failures=0
+for SCRIPT in $(ls -l ./bin/openapi3/*.sh | grep -v all)
+do
+    if [ -f ${SCRIPT} -a -x ${SCRIPT} ]; then
+        echo "Running $SCRIPT (output to /dev/null)"
+        ${SCRIPT} 2>&1 > /dev/null
+        rc=$?
+        if [[ ${rc} != 0 ]]; then
+            >&2 echo "ERROR!! FAILED TO RUN ${SCRIPT}"
+            ((failures+=1))
+        else
+            ((successes+=1))
+        fi
+    fi
+done
+
+if (( failures > 0 )); then
+   >&2 echo "[ERROR] ${failures} out of $((failures+successes)) scripts failed."
+   exit 1
+else
+    echo "[SUCCESS] ${successes} generators finished."
+fi

bin/openapi3/windows/csharp-petstore.bat

@@ -0,0 +1,14 @@
+set executable=.\modules\openapi-generator-cli\target\openapi-generator-cli.jar
+
+If Not Exist %executable% (
+  mvn clean package
+)
+
+REM set JAVA_OPTS=%JAVA_OPTS% -Xmx1024M
+set ags=generate -i modules\openapi-generator\src\test/resources\2_0\petstore-with-fake-endpoints-models-for-testing.yaml -g csharp -o samples\openapi3\client\petstore\csharp\SwaggerClient --additional-properties packageGuid={321C8C3F-0156-40C1-AE42-D59761FB9B6C}
+
+java %JAVA_OPTS% -jar %executable% %ags%
+
+REM restore csproj file
+echo "restore csproject file: CI\samples.ci\client\petstore\csharp\OpenAPIClient\src\Org.OpenAPITools.Test\Org.OpenAPITools.Test.csproj"
+copy /b/v/y CI\samples.ci\client\petstore\csharp\OpenAPIClient\src\Org.OpenAPITools.Test\Org.OpenAPITools.Test.csproj samples\openapi3\client\petstore\csharp\OpenAPIClient\src\Org.OpenAPITools.Test\

bin/openapi3/windows/run-all-petstore.cmd

@@ -0,0 +1,15 @@
+REM this batch file will loop through all the .bat files under bin\openapi3\windows\
+REM execute the script and check the error level to see if there's any error
+
+echo IMPORTANT: this script should be run by the CI (e.g. appveyor) only. There's no need to run this script to update Petstore samples for all generators.
+echo Please press CTRL+C to stop or the script will continue in 10 seconds.
+
+timeout 10
+
+for /f "delims=" %%i in ('dir /b ".\bin\openapi3\windows\*.bat"') do (
+
+  CALL .\bin\openapi3\windows\%%i
+
+  IF ERRORLEVEL 1 IF NOT ERRORLEVEL 2 exit /b 1
+
+)

bin/run-all-petstore

@@ -13,8 +13,8 @@ failures=0
 for SCRIPT in $(ls -l ./bin/*.sh | grep -v all)
 do
     if [ -f ${SCRIPT} -a -x ${SCRIPT} ]; then
-        echo "Running $SCRIPT"
-        ${SCRIPT}
+        echo "Running $SCRIPT (output to /dev/null)"
+        ${SCRIPT} 2>&1 > /dev/null
         rc=$?
         if [[ ${rc} != 0 ]]; then
             >&2 echo "ERROR!! FAILED TO RUN ${SCRIPT}"
@@ -30,4 +30,4 @@ if (( failures > 0 )); then
    exit 1
 else
     echo "[SUCCESS] ${successes} generators finished."
-fi
+fi

bin/utils/ensure-up-to-date

@@ -31,7 +31,8 @@ sleep 5
 ./bin/typescript-inversify-petstore.sh > /dev/null 2>&1
 ./bin/rust-server-petstore.sh > /dev/null 2>&1
 ./bin/openapi3/haskell-http-client-petstore.sh > /dev/null 2>&1
-./bin/meta-codegen.sh
+./bin/csharp-petstore.sh > /dev/null 2>&1
+./bin/meta-codegen.sh > /dev/null 2>&1
 
 # Check:
 if [ -n "$(git status --porcelain)" ]; then

bin/windows/csharp-petstore-net-40.bat

@@ -5,6 +5,6 @@ If Not Exist %executable% (
 )
 
 REM set JAVA_OPTS=%JAVA_OPTS% -Xmx1024M
-set ags=generate -i modules/openapi-generator/src/test/resources/2_0/petstore-with-fake-endpoints-models-for-testing.yaml -g csharp -o samples/client/petstore/csharp/SwaggerClientNet40 --additional-properties packageGuid={321C8C3F-0156-40C1-AE42-D59761FB9B6C} -c ./bin/csharp-petstore-net-40.json
+set ags=generate -i modules\openapi-generator\src\test\resources\2_0\petstore-with-fake-endpoints-models-for-testing.yaml -g csharp -o samples\client\petstore\csharp\SwaggerClientNet40 --additional-properties packageGuid={321C8C3F-0156-40C1-AE42-D59761FB9B6C} -c .\bin\csharp-petstore-net-40.json
 
 java %JAVA_OPTS% -jar %executable% %ags%

bin/windows/csharp-petstore-netstandard.bat

@@ -5,6 +5,6 @@ If Not Exist %executable% (
 )
 
 REM set JAVA_OPTS=%JAVA_OPTS% -Xmx1024M
-set ags=generate -i modules/openapi-generator/src/test/resources/2_0/petstore-with-fake-endpoints-models-for-testing.yaml -g csharp -o samples\client\petstore\csharp\SwaggerClientNetStandard --additional-properties targetFramework=v5.0,packageGuid={3AB1F259-1769-484B-9411-84505FCCBD55}
+set ags=generate -i modules\openapi-generator\src\test\resources\2_0\petstore-with-fake-endpoints-models-for-testing.yaml -g csharp -o samples\client\petstore\csharp\SwaggerClientNetStandard --additional-properties targetFramework=v5.0,packageGuid={3AB1F259-1769-484B-9411-84505FCCBD55}
 
 java %JAVA_OPTS% -jar %executable% %ags%

bin/windows/csharp-petstore.bat

@@ -9,7 +9,7 @@ set ags=generate -i modules\openapi-generator\src\test/resources\2_0\petstore-wi
 
 java %JAVA_OPTS% -jar %executable% %ags%
 
-# restore csproj file
-echo "restore csproject file: CI\samples\client\petstore\csharp\OpenAPIClient\src\Org.OpenAPITools.Test\Org.OpenAPITools.Test.csproj"
-copy .\CI\samples\client\petstore\csharp\OpenAPIClient\src\Org.OpenAPITools.Test\Org.OpenAPITools.Test.csproj .\samples\client\petstore\csharp\OpenAPIClient\src\Org.OpenAPITools.Test\
+REM restore csproj file
+echo "restore csproject file: CI\samples.ci\client\petstore\csharp\OpenAPIClient\src\Org.OpenAPITools.Test\Org.OpenAPITools.Test.csproj"
+copy /b/v/y CI\samples.ci\client\petstore\csharp\OpenAPIClient\src\Org.OpenAPITools.Test\Org.OpenAPITools.Test.csproj samples\client\petstore\csharp\OpenAPIClient\src\Org.OpenAPITools.Test\
 

bin/windows/html-petstore.bat

@@ -5,6 +5,6 @@ If Not Exist %executable% (
 )
 
 REM set JAVA_OPTS=%JAVA_OPTS% -Xmx1024M -DloggerPath=conf/log4j.properties
-set ags=generate -i modules\openapi-generator\src\test\resources\2_0\petstore.yaml -g html -o samples\client\petstore\html
+set ags=generate -i modules\openapi-generator\src\test\resources\2_0\petstore.yaml -g html -o samples\documentation\html
 
 java %JAVA_OPTS% -jar %executable% %ags%

bin/windows/html2-petstore.bat

@@ -5,6 +5,6 @@ If Not Exist %executable% (
 )
 
 REM set JAVA_OPTS=%JAVA_OPTS% -Xmx1024M -DloggerPath=conf/log4j.properties
-set ags=generate -i modules\openapi-generator\src\test\resources\2_0\petstore.yaml -g html2 -o samples\html2
+set ags=generate -i modules\openapi-generator\src\test\resources\2_0\petstore.yaml -g html2 -o samples\documentation\html2
 
 java %JAVA_OPTS% -jar %executable% %ags%

modules/openapi-generator-maven-plugin/README.md

@@ -37,6 +37,8 @@ mvn clean compile
 
 ### General Configuration parameters
 
+:bulb: These **general** configurations should be in the same level
+
 - `inputSpec` - OpenAPI Spec file path
 - `validateSpec` - Whether or not to validate the input spec prior to generation. Invalid specifications will result in an error.
 - `language` - target generation language (deprecated, replaced by `generatorName` as values here don't represent only 'language' any longer)
@@ -49,7 +51,7 @@ mvn clean compile
 - `invokerPackage` - the package to use for the generated invoker objects
 - `modelNamePrefix` and `modelNameSuffix` - Sets the pre- or suffix for model classes and enums
 - `withXml` - enable XML annotations inside the generated models and API (only works with Java `language` and libraries that provide support for JSON and XML)
-- `configOptions` - a map of language-specific parameters (see below)
+- `configOptions` - a map of language-specific parameters. To show a full list of generator-specified parameters (options), please use `configHelp` (explained below)
 - `configHelp` - dumps the configuration help for the specified library (generates no sources)
 - `ignoreFileOverride` - specifies the full path to a `.openapi-generator-ignore` used for pattern based overrides of generated outputs
 - `generateApis` - generate the apis (`true` by default)

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

@@ -19,6 +19,7 @@
 
 import com.google.common.collect.ImmutableMap;
 import com.samskivert.mustache.Mustache;
+import io.swagger.v3.core.util.Json;
 import org.apache.commons.lang3.StringUtils;
 import org.openapitools.codegen.*;
 import org.openapitools.codegen.utils.*;
@@ -713,12 +714,22 @@ public String toDefaultValue(Schema p) {
                 return p.getDefault().toString();
             }
         } else if (ModelUtils.isDateSchema(p)) {
-            // TODO
+            if (p.getDefault() != null) {
+                return "\"" + p.getDefault().toString() + "\"";
+            }
         } else if (ModelUtils.isDateTimeSchema(p)) {
-            // TODO
+            if (p.getDefault() != null) {
+                return "\"" + p.getDefault().toString() + "\"";
+            }
         } else if (ModelUtils.isNumberSchema(p)) {
             if (p.getDefault() != null) {
-                return p.getDefault().toString();
+                if (ModelUtils.isFloatSchema(p)) { // float
+                    return p.getDefault().toString() + "F";
+                } else if (ModelUtils.isDoubleSchema(p)) { // double
+                    return p.getDefault().toString() + "D";
+                } else {
+                    return p.getDefault().toString();
+                }
             }
         } else if (ModelUtils.isIntegerSchema(p)) {
             if (p.getDefault() != null) {
@@ -967,4 +978,42 @@ public boolean isDataTypeString(String dataType) {
         // also treat double/decimal/float as "string" in enum so that the values (e.g. 2.8) get double-quoted
         return "String".equalsIgnoreCase(dataType) || "double?".equals(dataType) || "decimal?".equals(dataType) || "float?".equals(dataType);
     }
+
+    @Override
+    public void setParameterExampleValue(CodegenParameter codegenParameter) {
+
+        // set the example value
+        // if not specified in x-example, generate a default value
+        // TODO need to revise how to obtain the example value
+        if (codegenParameter.vendorExtensions != null && codegenParameter.vendorExtensions.containsKey("x-example")) {
+            codegenParameter.example = Json.pretty(codegenParameter.vendorExtensions.get("x-example"));
+        } else if (Boolean.TRUE.equals(codegenParameter.isBoolean)) {
+            codegenParameter.example = "true";
+        } else if (Boolean.TRUE.equals(codegenParameter.isLong)) {
+            codegenParameter.example = "789";
+        } else if (Boolean.TRUE.equals(codegenParameter.isInteger)) {
+            codegenParameter.example = "56";
+        } else if (Boolean.TRUE.equals(codegenParameter.isFloat)) {
+            codegenParameter.example = "3.4F";
+        } else if (Boolean.TRUE.equals(codegenParameter.isDouble)) {
+            codegenParameter.example = "1.2D";
+        } else if (Boolean.TRUE.equals(codegenParameter.isNumber)) {
+            codegenParameter.example = "8.14";
+        } else if (Boolean.TRUE.equals(codegenParameter.isBinary)) {
+            codegenParameter.example = "BINARY_DATA_HERE";
+        } else if (Boolean.TRUE.equals(codegenParameter.isByteArray)) {
+            codegenParameter.example = "BYTE_ARRAY_DATA_HERE";
+        } else if (Boolean.TRUE.equals(codegenParameter.isFile)) {
+            codegenParameter.example = "/path/to/file.txt";
+        } else if (Boolean.TRUE.equals(codegenParameter.isDate)) {
+            codegenParameter.example = "2013-10-20";
+        } else if (Boolean.TRUE.equals(codegenParameter.isDateTime)) {
+            codegenParameter.example = "2013-10-20T19:20:30+01:00";
+        } else if (Boolean.TRUE.equals(codegenParameter.isUuid)) {
+            codegenParameter.example = "38400000-8cf0-11bd-b23e-10b96e4ef00d";
+        } else if (Boolean.TRUE.equals(codegenParameter.isString)) {
+            codegenParameter.example = codegenParameter.paramName + "_example";
+        }
+
+    }
 }

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

@@ -603,11 +603,11 @@ public void postProcessModelProperty(CodegenModel model, CodegenProperty propert
     }
 
     /*
-    * The pattern spec follows the Perl convention and style of modifiers. .NET
-    * does not support this syntax directly so we need to convert the pattern to a .NET compatible
-    * format and apply modifiers in a compatible way.
-    * See https://msdn.microsoft.com/en-us/library/yd1hzczs(v=vs.110).aspx for .NET options.
-    */
+     * The pattern spec follows the Perl convention and style of modifiers. .NET
+     * does not support this syntax directly so we need to convert the pattern to a .NET compatible
+     * format and apply modifiers in a compatible way.
+     * See https://msdn.microsoft.com/en-us/library/yd1hzczs(v=vs.110).aspx for .NET options.
+     */
     public void postProcessPattern(String pattern, Map<String, Object> vendorExtensions) {
         if (pattern != null) {
             int i = pattern.lastIndexOf('/');
@@ -707,7 +707,7 @@ public String toEnumVarName(String value, String datatype) {
         }
 
         // number
-        if(datatype.startsWith("int") || datatype.startsWith("long") ||
+        if (datatype.startsWith("int") || datatype.startsWith("long") ||
                 datatype.startsWith("double") || datatype.startsWith("float")) {
             String varName = "NUMBER_" + value;
             varName = varName.replaceAll("-", "MINUS_");
@@ -751,13 +751,18 @@ public String toVarName(String name) {
 
     public String getNameUsingModelPropertyNaming(String name) {
         switch (CodegenConstants.MODEL_PROPERTY_NAMING_TYPE.valueOf(getModelPropertyNaming())) {
-            case original:    return name;
-            case camelCase:   return camelize(name, true);
-            case PascalCase:  return camelize(name);
-            case snake_case:  return underscore(name);
-            default:          throw new IllegalArgumentException("Invalid model property naming '" +
-                    name + "'. Must be 'original', 'camelCase', " +
-                    "'PascalCase' or 'snake_case'");
+            case original:
+                return name;
+            case camelCase:
+                return camelize(name, true);
+            case PascalCase:
+                return camelize(name);
+            case snake_case:
+                return underscore(name);
+            default:
+                throw new IllegalArgumentException("Invalid model property naming '" +
+                        name + "'. Must be 'original', 'camelCase', " +
+                        "'PascalCase' or 'snake_case'");
         }
     }