Merge pull request #6 from OpenAPITools/5-python-fails-to-deserialize-using-discriminator

Adds command line argument nonCompliantUseDiscriminatorIfCompositionFails

Author: spacether

CI/circle_parallel.sh

@@ -63,6 +63,7 @@ elif [ "$NODE_INDEX" = "4" ]; then
   #mvn --no-snapshot-updates --quiet verify -Psamples.circleci.node4 -Dorg.slf4j.simpleLogger.defaultLogLevel=error
   (cd samples/openapi3/client/petstore/python && make test)
   (cd samples/openapi3/client/3_0_3_unit_test/python && make test)
+  (cd samples/openapi3/client/features/nonCompliantUseDiscriminatorIfCompositionFails/python && make test)
 
 else
   echo "Running node $NODE_INDEX"

bin/configs/python_3_0_3_unit_test.yaml

@@ -0,0 +1,6 @@
+generatorName: python
+outputDir: samples/openapi3/client/3_0_3_unit_test/python
+inputSpec: modules/openapi-json-schema-generator/src/test/resources/3_0/unit_test_spec/3_0_3_unit_test_spec.yaml
+templateDir: modules/openapi-json-schema-generator/src/main/resources/python
+additionalProperties:
+  packageName: unit_test_api

bin/configs/python_nonCompliantUseDiscriminatorIfCompositionFails.yaml

@@ -0,0 +1,6 @@
+generatorName: python
+outputDir: samples/openapi3/client/features/nonCompliantUseDiscriminatorIfCompositionFails/python
+inputSpec: modules/openapi-json-schema-generator/src/test/resources/3_0/nonCompliantUseDiscriminatorIfCompositionFails.yaml
+additionalProperties:
+  packageName: this_package
+  nonCompliantUseDiscriminatorIfCompositionFails: true

bin/configs/unmaintained/python_3_0_3_unit_test.yaml

@@ -3,7 +3,7 @@
 SCRIPT="$0"
 echo "# START SCRIPT: ${SCRIPT}"
 
-executable="./modules/openapi-generator-cli/target/openapi-generator-cli.jar"
+executable="./modules/openapi-json-schema-generator-cli/target/openapi-json-schema-generator-cli.jar"
 
 if [[ "true" == "${SKIP_EXPORT_DOCS}" ]]; then
   echo "Skipping doc exports. Note that docs generated by Windows may break paths as they have not yet been normalized to OS-specific paths."

bin/utils/export_docs_generators.sh

@@ -12,6 +12,7 @@ else
     exit 1;
 fi
 
-executable="./modules/openapi-generator-cli/target/openapi-generator-cli.jar"
+executable="./modules/openapi-json-schema-generator-cli/target/openapi-json-schema-generator-cli.jar"
+
 
 java -jar ${executable} config-help -g "${NAME}" --full-details --named-header --format markdown --markdown-header -o "docs/generators/${NAME}.md"

bin/utils/export_generator.sh

@@ -34,7 +34,7 @@ These options may be applied as additional-properties (cli) or configOptions (pl
 |library|library template (sub-template) to use|<dl><dt>**volley**</dt><dd>HTTP client: Volley 1.0.19 (default)</dd><dt>**httpclient**</dt><dd>HTTP client: Apache HttpClient 4.3.6. JSON processing: Gson 2.3.1. IMPORTANT: Android client using HttpClient is not actively maintained and will be deprecated in the next major release.</dd></dl>|null|
 |modelPackage|package for generated models| |null|
 |prependFormOrBodyParameters|Add form or body parameters to the beginning of the parameter list.| |false|
-|serializableModel|boolean - toggle &quot;implements Serializable&quot; for generated models| |false|
+|serializableModel|boolean - toggle "implements Serializable" for generated models| |false|
 |sortModelPropertiesByRequiredFlag|Sort model properties to place required parameters before optional parameters.| |true|
 |sortParamsByRequiredFlag|Sort method arguments to place required parameters before optional parameters.| |true|
 |sourceFolder|source folder for generated code| |null|

docs/generators/android.md

@@ -33,7 +33,7 @@ These options may be applied as additional-properties (cli) or configOptions (pl
 |nullableReferenceTypes|Use nullable annotations in the project. Only supported on C# 8 / ASP.NET Core 3.1 or newer.| |false|
 |operationIsAsync|Set methods to async or sync (default).| |false|
 |operationModifier|Operation Modifier can be virtual or abstract|<dl><dt>**virtual**</dt><dd>Keep method virtual</dd><dt>**abstract**</dt><dd>Make method abstract</dd></dl>|virtual|
-|operationResultTask|Set methods result to Task&lt;&gt;.| |false|
+|operationResultTask|Set methods result to Task<>.| |false|
 |packageAuthors|Specifies Authors property in the .NET Core project file.| |OpenAPI|
 |packageCopyright|Specifies an AssemblyCopyright for the .NET Framework global assembly attributes stored in the AssemblyInfo file.| |No Copyright|
 |packageDescription|Specifies a AssemblyDescription for the .NET Framework global assembly attributes stored in the AssemblyInfo file.| |A library generated from a OpenAPI doc|
@@ -42,11 +42,11 @@ These options may be applied as additional-properties (cli) or configOptions (pl
 |packageTitle|Specifies an AssemblyTitle for the .NET Framework global assembly attributes stored in the AssemblyInfo file.| |OpenAPI Library|
 |packageVersion|C# package version.| |1.0.0|
 |pocoModels|Build POCO Models| |false|
-|returnICollection|Return ICollection&lt;T&gt; instead of the concrete type.| |false|
+|returnICollection|Return ICollection<T> instead of the concrete type.| |false|
 |sortParamsByRequiredFlag|Sort method arguments to place required parameters before optional parameters.| |true|
 |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|
+|useCollection|Deserialize array types to Collection<T> instead of List<T>.| |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|

docs/generators/aspnetcore.md

@@ -25,12 +25,12 @@ These options may be applied as additional-properties (cli) or configOptions (pl
 |enumUnknownDefaultCase|If the server adds new enum cases, that are unknown by an old spec/client, the client will fail to parse the network response.With this option enabled, each enum will have a new case, 'unknown_default_open_api', so that when the server sends an enum case that is not known by the client/spec, they can safely fallback to this case.|<dl><dt>**false**</dt><dd>No changes to the enum's are made, this is the default option.</dd><dt>**true**</dt><dd>With this option enabled, each enum will have a new case, 'unknown_default_open_api', so that when the enum case sent by the server is not known by the client/spec, can safely be decoded to this case.</dd></dl>|false|
 |legacyDiscriminatorBehavior|Set to false for generators with better support for discriminators. (Python, Java, Go, PowerShell, C#have this enabled by default).|<dl><dt>**true**</dt><dd>The mapping in the discriminator includes descendent schemas that allOf inherit from self and the discriminator mapping schemas in the OAS document.</dd><dt>**false**</dt><dd>The mapping in the discriminator includes any descendent schemas that allOf inherit from self, any oneOf schemas, any anyOf schemas, any x-discriminator-values, and the discriminator mapping schemas in the OAS document AND Codegen validates that oneOf and anyOf schemas contain the required discriminator and throws an error if the discriminator is missing.</dd></dl>|true|
 |prependFormOrBodyParameters|Add form or body parameters to the beginning of the parameter list.| |false|
-|projectDescription|description of the project (Default: using info.description or &quot;Client library of &lt;projectName&gt;&quot;)| |null|
+|projectDescription|description of the project (Default: using info.description or "Client library of <projectName>")| |null|
 |projectLicenseName|name of the license the project uses (Default: using info.license.name or not included in project.clj)| |null|
 |projectLicenseUrl|URL of the license the project uses (Default: using info.license.url or not included in project.clj)| |null|
-|projectName|name of the project (Default: generated from info.title or &quot;openapi-clj-client&quot;)| |null|
+|projectName|name of the project (Default: generated from info.title or "openapi-clj-client")| |null|
 |projectUrl|URL of the project (Default: using info.contact.url or not included in project.clj)| |null|
-|projectVersion|version of the project (Default: using info.version or &quot;1.0.0&quot;)| |null|
+|projectVersion|version of the project (Default: using info.version or "1.0.0")| |null|
 |sortModelPropertiesByRequiredFlag|Sort model properties to place required parameters before optional parameters.| |true|
 |sortParamsByRequiredFlag|Sort method arguments to place required parameters before optional parameters.| |true|
 

docs/generators/clojure.md

@@ -22,7 +22,7 @@ These options may be applied as additional-properties (cli) or configOptions (pl
 |helpersPackage|Specify the package name to be used for the helpers (e.g. org.openapitools.server.helpers).| |org.openapitools.server.helpers|
 |reservedWordPrefix|Prefix to prepend to reserved words in order to avoid conflicts| |r_|
 |useStructModel|Use struct-based model template instead of get/set-based model template| |false|
-|variableNameFirstCharacterUppercase|Make first character of variable name uppercase (eg. value -> Value)| |true|
+|variableNameFirstCharacterUppercase|Make first character of variable name uppercase (eg. value -> Value)| |true|
 
 ## IMPORT MAPPING
 

docs/generators/cpp-pistache-server.md

@@ -31,7 +31,7 @@ These options may be applied as additional-properties (cli) or configOptions (pl
 |reservedWordPrefix|Prefix to prepend to reserved words in order to avoid conflicts| |r_|
 |sortModelPropertiesByRequiredFlag|Sort model properties to place required parameters before optional parameters.| |true|
 |sortParamsByRequiredFlag|Sort method arguments to place required parameters before optional parameters.| |true|
-|variableNameFirstCharacterUppercase|Make first character of variable name uppercase (eg. value -> Value)| |true|
+|variableNameFirstCharacterUppercase|Make first character of variable name uppercase (eg. value -> Value)| |true|
 
 ## IMPORT MAPPING
 

docs/generators/cpp-qt-client.md

@@ -30,7 +30,7 @@ These options may be applied as additional-properties (cli) or configOptions (pl
 |reservedWordPrefix|Prefix to prepend to reserved words in order to avoid conflicts| |r_|
 |sortModelPropertiesByRequiredFlag|Sort model properties to place required parameters before optional parameters.| |true|
 |sortParamsByRequiredFlag|Sort method arguments to place required parameters before optional parameters.| |true|
-|variableNameFirstCharacterUppercase|Make first character of variable name uppercase (eg. value -> Value)| |true|
+|variableNameFirstCharacterUppercase|Make first character of variable name uppercase (eg. value -> Value)| |true|
 
 ## IMPORT MAPPING
 

docs/generators/cpp-qt-qhttpengine-server.md

@@ -20,7 +20,7 @@ These options may be applied as additional-properties (cli) or configOptions (pl
 | ------ | ----------- | ------ | ------- |
 |apiPackage|C++ namespace for apis (convention: name.space.api).| |org.openapitools.server.api|
 |declspec|C++ preprocessor to place before the class name for handling dllexport/dllimport.| ||
-|defaultInclude|The default include statement that should be placed in all headers for including things like the declspec (convention: #include "Commons.h" | ||
+|defaultInclude|The default include statement that should be placed in all headers for including things like the declspec (convention: #include "Commons.h" | ||
 |modelPackage|C++ namespace for models (convention: name.space.model).| |org.openapitools.server.model|
 |packageVersion|C++ package version.| |1.0.0|
 |reservedWordPrefix|Prefix to prepend to reserved words in order to avoid conflicts| |r_|

docs/generators/cpp-restbed-server-deprecated.md

@@ -20,7 +20,7 @@ These options may be applied as additional-properties (cli) or configOptions (pl
 | ------ | ----------- | ------ | ------- |
 |apiPackage|C++ namespace for apis (convention: name.space.api).| |org.openapitools.server.api|
 |declspec|C++ preprocessor to place before the class name for handling dllexport/dllimport.| ||
-|defaultInclude|The default include statement that should be placed in all headers for including things like the declspec (convention: #include "Commons.h" | ||
+|defaultInclude|The default include statement that should be placed in all headers for including things like the declspec (convention: #include "Commons.h" | ||
 |modelPackage|C++ namespace for models (convention: name.space.model).| |org.openapitools.server.model|
 |packageVersion|C++ package version.| |1.0.0|
 |reservedWordPrefix|Prefix to prepend to reserved words in order to avoid conflicts| |r_|

docs/generators/cpp-restbed-server.md

@@ -20,13 +20,13 @@ These options may be applied as additional-properties (cli) or configOptions (pl
 | ------ | ----------- | ------ | ------- |
 |apiPackage|C++ namespace for apis (convention: name.space.api).| |org.openapitools.client.api|
 |declspec|C++ preprocessor to place before the class name for handling dllexport/dllimport.| ||
-|defaultInclude|The default include statement that should be placed in all headers for including things like the declspec (convention: #include "Commons.h" | ||
+|defaultInclude|The default include statement that should be placed in all headers for including things like the declspec (convention: #include "Commons.h" | ||
 |generateGMocksForApis|Generate Google Mock classes for APIs.| |null|
 |modelPackage|C++ namespace for models (convention: name.space.model).| |org.openapitools.client.model|
 |packageName|C++ package (library) name.| |CppRestOpenAPIClient|
 |packageVersion|C++ package version.| |1.0.0|
 |reservedWordPrefix|Prefix to prepend to reserved words in order to avoid conflicts| |r_|
-|variableNameFirstCharacterUppercase|Make first character of variable name uppercase (eg. value -> Value)| |true|
+|variableNameFirstCharacterUppercase|Make first character of variable name uppercase (eg. value -> Value)| |true|
 
 ## IMPORT MAPPING
 

docs/generators/cpp-restsdk.md

@@ -28,7 +28,7 @@ These options may be applied as additional-properties (cli) or configOptions (pl
 |reservedWordPrefix|Prefix to prepend to reserved words in order to avoid conflicts| |r_|
 |sortModelPropertiesByRequiredFlag|Sort model properties to place required parameters before optional parameters.| |true|
 |sortParamsByRequiredFlag|Sort method arguments to place required parameters before optional parameters.| |true|
-|variableNameFirstCharacterUppercase|Make first character of variable name uppercase (eg. value -> Value)| |true|
+|variableNameFirstCharacterUppercase|Make first character of variable name uppercase (eg. value -> Value)| |true|
 
 ## IMPORT MAPPING
 

docs/generators/cpp-tiny.md

@@ -27,7 +27,7 @@ These options may be applied as additional-properties (cli) or configOptions (pl
 |reservedWordPrefix|Prefix to prepend to reserved words in order to avoid conflicts| |r_|
 |sortModelPropertiesByRequiredFlag|Sort model properties to place required parameters before optional parameters.| |true|
 |sortParamsByRequiredFlag|Sort method arguments to place required parameters before optional parameters.| |true|
-|variableNameFirstCharacterUppercase|Make first character of variable name uppercase (eg. value -> Value)| |true|
+|variableNameFirstCharacterUppercase|Make first character of variable name uppercase (eg. value -> Value)| |true|
 
 ## IMPORT MAPPING
 

docs/generators/cpp-tizen.md

@@ -30,7 +30,7 @@ These options may be applied as additional-properties (cli) or configOptions (pl
 |sortModelPropertiesByRequiredFlag|Sort model properties to place required parameters before optional parameters.| |true|
 |sortParamsByRequiredFlag|Sort method arguments to place required parameters before optional parameters.| |true|
 |unrealModuleName|Name of the generated unreal module (optional)| |OpenAPI|
-|variableNameFirstCharacterUppercase|Make first character of variable name uppercase (eg. value -> Value)| |true|
+|variableNameFirstCharacterUppercase|Make first character of variable name uppercase (eg. value -> Value)| |true|
 
 ## IMPORT MAPPING
 

docs/generators/cpp-ue4.md

@@ -32,18 +32,18 @@ These options may be applied as additional-properties (cli) or configOptions (pl
 |nullableReferenceTypes|Use nullable annotations in the project. Only supported on C# 8 / ASP.NET Core 3.1 or newer.| |false|
 |operationIsAsync|Set methods to async or sync (default).| |false|
 |operationModifier|Operation Modifier can be virtual or abstract|<dl><dt>**virtual**</dt><dd>Keep method virtual</dd><dt>**abstract**</dt><dd>Make method abstract</dd></dl>|virtual|
-|operationResultTask|Set methods result to Task&lt;&gt;.| |false|
+|operationResultTask|Set methods result to Task<>.| |false|
 |packageAuthors|Specifies Authors property in the .NET Core project file.| |OpenAPI|
 |packageCopyright|Specifies an AssemblyCopyright for the .NET Framework global assembly attributes stored in the AssemblyInfo file.| |No Copyright|
 |packageDescription|Specifies a AssemblyDescription for the .NET Framework global assembly attributes stored in the AssemblyInfo file.| |A library generated from a OpenAPI doc|
 |packageGuid|The GUID that will be associated with the C# project| |null|
 |packageName|C# package name (convention: Title.Case).| |Org.OpenAPITools|
 |packageTitle|Specifies an AssemblyTitle for the .NET Framework global assembly attributes stored in the AssemblyInfo file.| |OpenAPI Library|
 |packageVersion|C# package version.| |1.0.0|
-|returnICollection|Return ICollection&lt;T&gt; instead of the concrete type.| |false|
+|returnICollection|Return ICollection<T> instead of the concrete type.| |false|
 |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&lt;T&gt; instead of List&lt;T&gt;.| |false|
+|useCollection|Deserialize array types to Collection<T> instead of List<T>.| |false|
 |useDateTimeOffset|Use DateTimeOffset to model date-time properties| |false|
 |useNewtonsoft|Uses the Newtonsoft JSON library.| |true|
 

docs/generators/csharp-netcore-functions.md

@@ -40,10 +40,10 @@ These options may be applied as additional-properties (cli) or configOptions (pl
 |packageTags|Tags to identify the package| |null|
 |packageVersion|C# package version.| |1.0.0|
 |releaseNote|Release note, default to 'Minor update'.| |Minor update|
-|returnICollection|Return ICollection<T> instead of the concrete type.| |false|
+|returnICollection|Return ICollection<T> instead of the concrete type.| |false|
 |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 compatible</dd><dt>**netstandard1.4**</dt><dd>.NET Standard 1.4 compatible</dd><dt>**netstandard1.5**</dt><dd>.NET Standard 1.5 compatible</dd><dt>**netstandard1.6**</dt><dd>.NET Standard 1.6 compatible</dd><dt>**netstandard2.0**</dt><dd>.NET Standard 2.0 compatible</dd><dt>**netstandard2.1**</dt><dd>.NET Standard 2.1 compatible</dd><dt>**netcoreapp3.1**</dt><dd>.NET Core 3.1 compatible</dd><dt>**net47**</dt><dd>.NET Framework 4.7 compatible</dd><dt>**net5.0**</dt><dd>.NET 5.0 compatible</dd><dt>**net6.0**</dt><dd>.NET 6.0 compatible</dd></dl>|netstandard2.0|
-|useCollection|Deserialize array types to Collection&lt;T&gt; instead of List&lt;T&gt;.| |false|
+|useCollection|Deserialize array types to Collection<T> instead of List<T>.| |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|
 |validatable|Generates self-validatable models.| |true|