diff --git a/docs/generators/ada-server.md b/docs/generators/ada-server.md index bf3952b2817cbc62bddf22a3819a8c98250f1277..515ee1bcf34c834822fb4fa9ab0fd3cbaa2f27c6 100644 --- a/docs/generators/ada-server.md +++ b/docs/generators/ada-server.md @@ -30,6 +30,15 @@ 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| +## SUPPORTED VENDOR EXTENSIONS + +| Extension name | Description | Applicable for | Default value | +| -------------- | ----------- | -------------- | ------------- | +|x-all-of-name|Specify the name of the generated allOf composed schema|MODEL|null| +|x-one-of-name|Specify the name of the generated oneOf composed schema|MODEL|null| +|x-is-one-of-interface|Generate the oneOf composed schema as a marker interface|MODEL|null| + + ## IMPORT MAPPING | Type/Alias | Imports | diff --git a/docs/generators/ada.md b/docs/generators/ada.md index 91378a4543588ce17971188dcba5c4ebc246a5f6..843ee845b67d1afcbe804e08a9869a44d2208dac 100644 --- a/docs/generators/ada.md +++ b/docs/generators/ada.md @@ -30,6 +30,15 @@ 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| +## SUPPORTED VENDOR EXTENSIONS + +| Extension name | Description | Applicable for | Default value | +| -------------- | ----------- | -------------- | ------------- | +|x-all-of-name|Specify the name of the generated allOf composed schema|MODEL|null| +|x-one-of-name|Specify the name of the generated oneOf composed schema|MODEL|null| +|x-is-one-of-interface|Generate the oneOf composed schema as a marker interface|MODEL|null| + + ## IMPORT MAPPING | Type/Alias | Imports | diff --git a/docs/generators/android.md b/docs/generators/android.md index 650b819bea61237fb2746c2368cda4e90d77164a..a811235eaa1d359553a7b4661d0750dd264ddfff 100644 --- a/docs/generators/android.md +++ b/docs/generators/android.md @@ -40,6 +40,15 @@ These options may be applied as additional-properties (cli) or configOptions (pl |sourceFolder|source folder for generated code| |null| |useAndroidMavenGradlePlugin|A flag to toggle android-maven gradle plugin.| |true| +## SUPPORTED VENDOR EXTENSIONS + +| Extension name | Description | Applicable for | Default value | +| -------------- | ----------- | -------------- | ------------- | +|x-all-of-name|Specify the name of the generated allOf composed schema|MODEL|null| +|x-one-of-name|Specify the name of the generated oneOf composed schema|MODEL|null| +|x-is-one-of-interface|Generate the oneOf composed schema as a marker interface|MODEL|null| + + ## IMPORT MAPPING | Type/Alias | Imports | diff --git a/docs/generators/apache2.md b/docs/generators/apache2.md index 8cc8e289328f7a20254d0a4ce31903b45deecab3..dbf9ca085467a28f84584f05f171d04d86cbf2d0 100644 --- a/docs/generators/apache2.md +++ b/docs/generators/apache2.md @@ -28,6 +28,15 @@ These options may be applied as additional-properties (cli) or configOptions (pl |sortParamsByRequiredFlag|Sort method arguments to place required parameters before optional parameters.| |true| |userInfoPath|Path to the user and group files| |null| +## SUPPORTED VENDOR EXTENSIONS + +| Extension name | Description | Applicable for | Default value | +| -------------- | ----------- | -------------- | ------------- | +|x-all-of-name|Specify the name of the generated allOf composed schema|MODEL|null| +|x-one-of-name|Specify the name of the generated oneOf composed schema|MODEL|null| +|x-is-one-of-interface|Generate the oneOf composed schema as a marker interface|MODEL|null| + + ## IMPORT MAPPING | Type/Alias | Imports | diff --git a/docs/generators/apex.md b/docs/generators/apex.md index f92f9e57177a9c06d1878d3646dc97c785362ab6..337229ff067d18f85b56421e739a80997e075e53 100644 --- a/docs/generators/apex.md +++ b/docs/generators/apex.md @@ -31,6 +31,15 @@ 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| +## SUPPORTED VENDOR EXTENSIONS + +| Extension name | Description | Applicable for | Default value | +| -------------- | ----------- | -------------- | ------------- | +|x-all-of-name|Specify the name of the generated allOf composed schema|MODEL|null| +|x-one-of-name|Specify the name of the generated oneOf composed schema|MODEL|null| +|x-is-one-of-interface|Generate the oneOf composed schema as a marker interface|MODEL|null| + + ## IMPORT MAPPING | Type/Alias | Imports | diff --git a/docs/generators/asciidoc.md b/docs/generators/asciidoc.md index 712f00d17b46e3c5d38655caf6802457b49a96e1..aaf4e33d9dcb42e16426434f8bc8fc8332af8410 100644 --- a/docs/generators/asciidoc.md +++ b/docs/generators/asciidoc.md @@ -44,6 +44,15 @@ These options may be applied as additional-properties (cli) or configOptions (pl |useMethodAndPath|Use HTTP method and path as operation heading, instead of operation id (default: false)| |false| |useTableTitles|Use titles for tables, rather than wrapping tables instead their own section (default: false)| |false| +## SUPPORTED VENDOR EXTENSIONS + +| Extension name | Description | Applicable for | Default value | +| -------------- | ----------- | -------------- | ------------- | +|x-all-of-name|Specify the name of the generated allOf composed schema|MODEL|null| +|x-one-of-name|Specify the name of the generated oneOf composed schema|MODEL|null| +|x-is-one-of-interface|Generate the oneOf composed schema as a marker interface|MODEL|null| + + ## IMPORT MAPPING | Type/Alias | Imports | diff --git a/docs/generators/aspnetcore.md b/docs/generators/aspnetcore.md index 685aee8fd94d43dece058bd3d741368450dccdf2..405175b168cce073a5fd6f6a8f60435606506d10 100644 --- a/docs/generators/aspnetcore.md +++ b/docs/generators/aspnetcore.md @@ -52,6 +52,15 @@ These options may be applied as additional-properties (cli) or configOptions (pl |useNewtonsoft|Uses the Newtonsoft JSON library.| |true| |useSwashbuckle|Uses the Swashbuckle.AspNetCore NuGet package for documentation.| |true| +## SUPPORTED VENDOR EXTENSIONS + +| Extension name | Description | Applicable for | Default value | +| -------------- | ----------- | -------------- | ------------- | +|x-all-of-name|Specify the name of the generated allOf composed schema|MODEL|null| +|x-one-of-name|Specify the name of the generated oneOf composed schema|MODEL|null| +|x-is-one-of-interface|Generate the oneOf composed schema as a marker interface|MODEL|null| + + ## IMPORT MAPPING | Type/Alias | Imports | diff --git a/docs/generators/avro-schema.md b/docs/generators/avro-schema.md index 8ea48f628820e4f2178a49ae5cf78ac966a8a4e2..2baebc567426265037913a9baa5eb641d38ae2b8 100644 --- a/docs/generators/avro-schema.md +++ b/docs/generators/avro-schema.md @@ -28,6 +28,15 @@ 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| +## SUPPORTED VENDOR EXTENSIONS + +| Extension name | Description | Applicable for | Default value | +| -------------- | ----------- | -------------- | ------------- | +|x-all-of-name|Specify the name of the generated allOf composed schema|MODEL|null| +|x-one-of-name|Specify the name of the generated oneOf composed schema|MODEL|null| +|x-is-one-of-interface|Generate the oneOf composed schema as a marker interface|MODEL|null| + + ## IMPORT MAPPING | Type/Alias | Imports | diff --git a/docs/generators/bash.md b/docs/generators/bash.md index 8a4f10696e34d9ae80f738f92cb4f8cb6b355a5e..c726bba2a43727ca75fec933731cc5e6f51c3046 100644 --- a/docs/generators/bash.md +++ b/docs/generators/bash.md @@ -35,6 +35,15 @@ 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| +## SUPPORTED VENDOR EXTENSIONS + +| Extension name | Description | Applicable for | Default value | +| -------------- | ----------- | -------------- | ------------- | +|x-all-of-name|Specify the name of the generated allOf composed schema|MODEL|null| +|x-one-of-name|Specify the name of the generated oneOf composed schema|MODEL|null| +|x-is-one-of-interface|Generate the oneOf composed schema as a marker interface|MODEL|null| + + ## IMPORT MAPPING | Type/Alias | Imports | diff --git a/docs/generators/c.md b/docs/generators/c.md index 3bab335a5f65207cc0cc66931dd82af89cb4d47b..209881b761039da2be7294b463ba72f6ab3d7cad 100644 --- a/docs/generators/c.md +++ b/docs/generators/c.md @@ -28,6 +28,15 @@ 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| +## SUPPORTED VENDOR EXTENSIONS + +| Extension name | Description | Applicable for | Default value | +| -------------- | ----------- | -------------- | ------------- | +|x-all-of-name|Specify the name of the generated allOf composed schema|MODEL|null| +|x-one-of-name|Specify the name of the generated oneOf composed schema|MODEL|null| +|x-is-one-of-interface|Generate the oneOf composed schema as a marker interface|MODEL|null| + + ## IMPORT MAPPING | Type/Alias | Imports | diff --git a/docs/generators/clojure.md b/docs/generators/clojure.md index 542a27c2998bf56c5bfbc47e8e390ac2f818bc4e..2acfd1c87ea0786405f4f8b466f9685e9d330abb 100644 --- a/docs/generators/clojure.md +++ b/docs/generators/clojure.md @@ -34,6 +34,15 @@ 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| +## SUPPORTED VENDOR EXTENSIONS + +| Extension name | Description | Applicable for | Default value | +| -------------- | ----------- | -------------- | ------------- | +|x-all-of-name|Specify the name of the generated allOf composed schema|MODEL|null| +|x-one-of-name|Specify the name of the generated oneOf composed schema|MODEL|null| +|x-is-one-of-interface|Generate the oneOf composed schema as a marker interface|MODEL|null| + + ## IMPORT MAPPING | Type/Alias | Imports | diff --git a/docs/generators/cpp-pistache-server.md b/docs/generators/cpp-pistache-server.md index e561cac7c5a2d8e07a58426f06dc510150a8a711..078c1641dd8b6f4cc80ce9603176fe3a12e2f9ff 100644 --- a/docs/generators/cpp-pistache-server.md +++ b/docs/generators/cpp-pistache-server.md @@ -24,6 +24,15 @@ These options may be applied as additional-properties (cli) or configOptions (pl |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| +## SUPPORTED VENDOR EXTENSIONS + +| Extension name | Description | Applicable for | Default value | +| -------------- | ----------- | -------------- | ------------- | +|x-all-of-name|Specify the name of the generated allOf composed schema|MODEL|null| +|x-one-of-name|Specify the name of the generated oneOf composed schema|MODEL|null| +|x-is-one-of-interface|Generate the oneOf composed schema as a marker interface|MODEL|null| + + ## IMPORT MAPPING | Type/Alias | Imports | diff --git a/docs/generators/cpp-qt-client.md b/docs/generators/cpp-qt-client.md index a03ff5bc48b10c551003484085d59027408d29e8..c9376620651873d2a5dff8694687a551de8f389b 100644 --- a/docs/generators/cpp-qt-client.md +++ b/docs/generators/cpp-qt-client.md @@ -33,6 +33,15 @@ These options may be applied as additional-properties (cli) or configOptions (pl |sortParamsByRequiredFlag|Sort method arguments to place required parameters before optional parameters.| |true| |variableNameFirstCharacterUppercase|Make first character of variable name uppercase (eg. value -> Value)| |true| +## SUPPORTED VENDOR EXTENSIONS + +| Extension name | Description | Applicable for | Default value | +| -------------- | ----------- | -------------- | ------------- | +|x-all-of-name|Specify the name of the generated allOf composed schema|MODEL|null| +|x-one-of-name|Specify the name of the generated oneOf composed schema|MODEL|null| +|x-is-one-of-interface|Generate the oneOf composed schema as a marker interface|MODEL|null| + + ## IMPORT MAPPING | Type/Alias | Imports | diff --git a/docs/generators/cpp-qt-qhttpengine-server.md b/docs/generators/cpp-qt-qhttpengine-server.md index 5de00c766389a360c6fe782a1468c8ec4751dd0d..b6570a234fe1cc36b378a93a3facf12059e2ce19 100644 --- a/docs/generators/cpp-qt-qhttpengine-server.md +++ b/docs/generators/cpp-qt-qhttpengine-server.md @@ -32,6 +32,15 @@ These options may be applied as additional-properties (cli) or configOptions (pl |sortParamsByRequiredFlag|Sort method arguments to place required parameters before optional parameters.| |true| |variableNameFirstCharacterUppercase|Make first character of variable name uppercase (eg. value -> Value)| |true| +## SUPPORTED VENDOR EXTENSIONS + +| Extension name | Description | Applicable for | Default value | +| -------------- | ----------- | -------------- | ------------- | +|x-all-of-name|Specify the name of the generated allOf composed schema|MODEL|null| +|x-one-of-name|Specify the name of the generated oneOf composed schema|MODEL|null| +|x-is-one-of-interface|Generate the oneOf composed schema as a marker interface|MODEL|null| + + ## IMPORT MAPPING | Type/Alias | Imports | diff --git a/docs/generators/cpp-restbed-server.md b/docs/generators/cpp-restbed-server.md index c499ba8e28dd8509caf2585789bb001798ed9aa3..ad37a749cc186cba5d5e3e201a1c7d5c9aba8a8a 100644 --- a/docs/generators/cpp-restbed-server.md +++ b/docs/generators/cpp-restbed-server.md @@ -25,6 +25,15 @@ These options may be applied as additional-properties (cli) or configOptions (pl |packageVersion|C++ package version.| |1.0.0| |reservedWordPrefix|Prefix to prepend to reserved words in order to avoid conflicts| |r_| +## SUPPORTED VENDOR EXTENSIONS + +| Extension name | Description | Applicable for | Default value | +| -------------- | ----------- | -------------- | ------------- | +|x-all-of-name|Specify the name of the generated allOf composed schema|MODEL|null| +|x-one-of-name|Specify the name of the generated oneOf composed schema|MODEL|null| +|x-is-one-of-interface|Generate the oneOf composed schema as a marker interface|MODEL|null| + + ## IMPORT MAPPING | Type/Alias | Imports | diff --git a/docs/generators/cpp-restsdk.md b/docs/generators/cpp-restsdk.md index 5cad57183bc6f08d783eb5eca266c5ee40a28f68..895ba83ecb219423ede57e47eb39a17e30dcc722 100644 --- a/docs/generators/cpp-restsdk.md +++ b/docs/generators/cpp-restsdk.md @@ -28,6 +28,15 @@ 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_| |variableNameFirstCharacterUppercase|Make first character of variable name uppercase (eg. value -> Value)| |true| +## SUPPORTED VENDOR EXTENSIONS + +| Extension name | Description | Applicable for | Default value | +| -------------- | ----------- | -------------- | ------------- | +|x-all-of-name|Specify the name of the generated allOf composed schema|MODEL|null| +|x-one-of-name|Specify the name of the generated oneOf composed schema|MODEL|null| +|x-is-one-of-interface|Generate the oneOf composed schema as a marker interface|MODEL|null| + + ## IMPORT MAPPING | Type/Alias | Imports | diff --git a/docs/generators/cpp-tiny.md b/docs/generators/cpp-tiny.md index ca65611bf81fe8d5746b3fa43dcd656e36e9843e..ee4100f984866eef51ec44d34d5984687c95705f 100644 --- a/docs/generators/cpp-tiny.md +++ b/docs/generators/cpp-tiny.md @@ -30,6 +30,15 @@ These options may be applied as additional-properties (cli) or configOptions (pl |sortParamsByRequiredFlag|Sort method arguments to place required parameters before optional parameters.| |true| |variableNameFirstCharacterUppercase|Make first character of variable name uppercase (eg. value -> Value)| |true| +## SUPPORTED VENDOR EXTENSIONS + +| Extension name | Description | Applicable for | Default value | +| -------------- | ----------- | -------------- | ------------- | +|x-all-of-name|Specify the name of the generated allOf composed schema|MODEL|null| +|x-one-of-name|Specify the name of the generated oneOf composed schema|MODEL|null| +|x-is-one-of-interface|Generate the oneOf composed schema as a marker interface|MODEL|null| + + ## IMPORT MAPPING | Type/Alias | Imports | diff --git a/docs/generators/cpp-tizen.md b/docs/generators/cpp-tizen.md index 9b5f89bb2c7157f773c44d0ccd4e62a2485f4fc9..b21673da9b9e0d5c70825534f9abc957b6836747 100644 --- a/docs/generators/cpp-tizen.md +++ b/docs/generators/cpp-tizen.md @@ -29,6 +29,15 @@ These options may be applied as additional-properties (cli) or configOptions (pl |sortParamsByRequiredFlag|Sort method arguments to place required parameters before optional parameters.| |true| |variableNameFirstCharacterUppercase|Make first character of variable name uppercase (eg. value -> Value)| |true| +## SUPPORTED VENDOR EXTENSIONS + +| Extension name | Description | Applicable for | Default value | +| -------------- | ----------- | -------------- | ------------- | +|x-all-of-name|Specify the name of the generated allOf composed schema|MODEL|null| +|x-one-of-name|Specify the name of the generated oneOf composed schema|MODEL|null| +|x-is-one-of-interface|Generate the oneOf composed schema as a marker interface|MODEL|null| + + ## IMPORT MAPPING | Type/Alias | Imports | diff --git a/docs/generators/cpp-ue4.md b/docs/generators/cpp-ue4.md index f619e7eaf7b589663d27a5a2e274bdbe584900ef..862444fef448974dab7c39a0807c9b2d40b76169 100644 --- a/docs/generators/cpp-ue4.md +++ b/docs/generators/cpp-ue4.md @@ -32,6 +32,15 @@ These options may be applied as additional-properties (cli) or configOptions (pl |unrealModuleName|Name of the generated unreal module (optional)| |OpenAPI| |variableNameFirstCharacterUppercase|Make first character of variable name uppercase (eg. value -> Value)| |true| +## SUPPORTED VENDOR EXTENSIONS + +| Extension name | Description | Applicable for | Default value | +| -------------- | ----------- | -------------- | ------------- | +|x-all-of-name|Specify the name of the generated allOf composed schema|MODEL|null| +|x-one-of-name|Specify the name of the generated oneOf composed schema|MODEL|null| +|x-is-one-of-interface|Generate the oneOf composed schema as a marker interface|MODEL|null| + + ## IMPORT MAPPING | Type/Alias | Imports | diff --git a/docs/generators/crystal.md b/docs/generators/crystal.md index 45aaac6e9e566175c5ad91986e7608bfac5cb503..d30f4600d62fea9da24468cf2334e176f414f6e8 100644 --- a/docs/generators/crystal.md +++ b/docs/generators/crystal.md @@ -35,6 +35,15 @@ 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| +## SUPPORTED VENDOR EXTENSIONS + +| Extension name | Description | Applicable for | Default value | +| -------------- | ----------- | -------------- | ------------- | +|x-all-of-name|Specify the name of the generated allOf composed schema|MODEL|null| +|x-one-of-name|Specify the name of the generated oneOf composed schema|MODEL|null| +|x-is-one-of-interface|Generate the oneOf composed schema as a marker interface|MODEL|null| + + ## IMPORT MAPPING | Type/Alias | Imports | diff --git a/docs/generators/csharp-dotnet2.md b/docs/generators/csharp-dotnet2.md index 274150134c9dce4a16d480608e30532b713c9d3e..4d0299d749fe889baa91767a03c9188163c16cd9 100644 --- a/docs/generators/csharp-dotnet2.md +++ b/docs/generators/csharp-dotnet2.md @@ -22,6 +22,15 @@ These options may be applied as additional-properties (cli) or configOptions (pl |packageName|C# package name (convention: Camel.Case).| |Org.OpenAPITools| |packageVersion|C# package version.| |1.0.0| +## SUPPORTED VENDOR EXTENSIONS + +| Extension name | Description | Applicable for | Default value | +| -------------- | ----------- | -------------- | ------------- | +|x-all-of-name|Specify the name of the generated allOf composed schema|MODEL|null| +|x-one-of-name|Specify the name of the generated oneOf composed schema|MODEL|null| +|x-is-one-of-interface|Generate the oneOf composed schema as a marker interface|MODEL|null| + + ## IMPORT MAPPING | Type/Alias | Imports | diff --git a/docs/generators/csharp-netcore-functions.md b/docs/generators/csharp-netcore-functions.md index e10d60e064c7640f8f53ccd18a4b2c3f9558bb06..6388e787c7c706053e4f1d935e1f4626594079e3 100644 --- a/docs/generators/csharp-netcore-functions.md +++ b/docs/generators/csharp-netcore-functions.md @@ -47,6 +47,15 @@ These options may be applied as additional-properties (cli) or configOptions (pl |useDateTimeOffset|Use DateTimeOffset to model date-time properties| |false| |useNewtonsoft|Uses the Newtonsoft JSON library.| |true| +## SUPPORTED VENDOR EXTENSIONS + +| Extension name | Description | Applicable for | Default value | +| -------------- | ----------- | -------------- | ------------- | +|x-all-of-name|Specify the name of the generated allOf composed schema|MODEL|null| +|x-one-of-name|Specify the name of the generated oneOf composed schema|MODEL|null| +|x-is-one-of-interface|Generate the oneOf composed schema as a marker interface|MODEL|null| + + ## IMPORT MAPPING | Type/Alias | Imports | diff --git a/docs/generators/csharp-netcore.md b/docs/generators/csharp-netcore.md index d39a59b2ba38a3b24f035e0d9db325845f877736..9da43e9423d202d2e90ed3eb8cf0de1db7bfee57 100644 --- a/docs/generators/csharp-netcore.md +++ b/docs/generators/csharp-netcore.md @@ -48,6 +48,15 @@ These options may be applied as additional-properties (cli) or configOptions (pl |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| +## SUPPORTED VENDOR EXTENSIONS + +| Extension name | Description | Applicable for | Default value | +| -------------- | ----------- | -------------- | ------------- | +|x-all-of-name|Specify the name of the generated allOf composed schema|MODEL|null| +|x-one-of-name|Specify the name of the generated oneOf composed schema|MODEL|null| +|x-is-one-of-interface|Generate the oneOf composed schema as a marker interface|MODEL|null| + + ## IMPORT MAPPING | Type/Alias | Imports | diff --git a/docs/generators/csharp.md b/docs/generators/csharp.md index 4caf9db56c8cef590bd10983622fe858c5534492..7af089539eacb44a322add80c6146f21cfe6b700 100644 --- a/docs/generators/csharp.md +++ b/docs/generators/csharp.md @@ -42,6 +42,15 @@ These options may be applied as additional-properties (cli) or configOptions (pl |useDateTimeOffset|Use DateTimeOffset to model date-time properties| |false| |validatable|Generates self-validatable models.| |true| +## SUPPORTED VENDOR EXTENSIONS + +| Extension name | Description | Applicable for | Default value | +| -------------- | ----------- | -------------- | ------------- | +|x-all-of-name|Specify the name of the generated allOf composed schema|MODEL|null| +|x-one-of-name|Specify the name of the generated oneOf composed schema|MODEL|null| +|x-is-one-of-interface|Generate the oneOf composed schema as a marker interface|MODEL|null| + + ## IMPORT MAPPING | Type/Alias | Imports | diff --git a/docs/generators/cwiki.md b/docs/generators/cwiki.md index 1f74c2420beb5d5688d865a82aca5c93be7fc96e..6ab36a39ccc7dab0988ef0399daff05fa0baa866 100644 --- a/docs/generators/cwiki.md +++ b/docs/generators/cwiki.md @@ -36,6 +36,15 @@ 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| +## SUPPORTED VENDOR EXTENSIONS + +| Extension name | Description | Applicable for | Default value | +| -------------- | ----------- | -------------- | ------------- | +|x-all-of-name|Specify the name of the generated allOf composed schema|MODEL|null| +|x-one-of-name|Specify the name of the generated oneOf composed schema|MODEL|null| +|x-is-one-of-interface|Generate the oneOf composed schema as a marker interface|MODEL|null| + + ## IMPORT MAPPING | Type/Alias | Imports | diff --git a/docs/generators/dart-dio-next.md b/docs/generators/dart-dio-next.md index d247192fd97c54f960d5ff7a90a155c8edced4a1..350d3517d42f170c7e570914fc6ccfaeab9e5b24 100644 --- a/docs/generators/dart-dio-next.md +++ b/docs/generators/dart-dio-next.md @@ -38,6 +38,15 @@ These options may be applied as additional-properties (cli) or configOptions (pl |sourceFolder|Source folder for generated code| |null| |useEnumExtension|Allow the 'x-enum-values' extension for enums| |null| +## SUPPORTED VENDOR EXTENSIONS + +| Extension name | Description | Applicable for | Default value | +| -------------- | ----------- | -------------- | ------------- | +|x-all-of-name|Specify the name of the generated allOf composed schema|MODEL|null| +|x-one-of-name|Specify the name of the generated oneOf composed schema|MODEL|null| +|x-is-one-of-interface|Generate the oneOf composed schema as a marker interface|MODEL|null| + + ## IMPORT MAPPING | Type/Alias | Imports | diff --git a/docs/generators/dart-dio.md b/docs/generators/dart-dio.md index b94bed6bcc7320665daf35c1224c31bd3cede4c9..72233cd5a44a1696b95b9c35ac7107aa5b055ee3 100644 --- a/docs/generators/dart-dio.md +++ b/docs/generators/dart-dio.md @@ -38,6 +38,15 @@ These options may be applied as additional-properties (cli) or configOptions (pl |sourceFolder|Source folder for generated code| |null| |useEnumExtension|Allow the 'x-enum-values' extension for enums| |null| +## SUPPORTED VENDOR EXTENSIONS + +| Extension name | Description | Applicable for | Default value | +| -------------- | ----------- | -------------- | ------------- | +|x-all-of-name|Specify the name of the generated allOf composed schema|MODEL|null| +|x-one-of-name|Specify the name of the generated oneOf composed schema|MODEL|null| +|x-is-one-of-interface|Generate the oneOf composed schema as a marker interface|MODEL|null| + + ## IMPORT MAPPING | Type/Alias | Imports | diff --git a/docs/generators/dart.md b/docs/generators/dart.md index 5c8c4ffac8b8ca8ec60b4f877e8a8ec3139ab7b7..80b83b753da9e8cb785901b0a7f9298fc875b2d5 100644 --- a/docs/generators/dart.md +++ b/docs/generators/dart.md @@ -37,6 +37,15 @@ These options may be applied as additional-properties (cli) or configOptions (pl |sourceFolder|Source folder for generated code| |null| |useEnumExtension|Allow the 'x-enum-values' extension for enums| |null| +## SUPPORTED VENDOR EXTENSIONS + +| Extension name | Description | Applicable for | Default value | +| -------------- | ----------- | -------------- | ------------- | +|x-all-of-name|Specify the name of the generated allOf composed schema|MODEL|null| +|x-one-of-name|Specify the name of the generated oneOf composed schema|MODEL|null| +|x-is-one-of-interface|Generate the oneOf composed schema as a marker interface|MODEL|null| + + ## IMPORT MAPPING | Type/Alias | Imports | diff --git a/docs/generators/dynamic-html.md b/docs/generators/dynamic-html.md index e9d3b13c8d066c0c936264416da0703e9eee5a9d..076f3f5e82cdfd89c32f70e7dab9a889abfc507b 100644 --- a/docs/generators/dynamic-html.md +++ b/docs/generators/dynamic-html.md @@ -30,6 +30,15 @@ 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| +## SUPPORTED VENDOR EXTENSIONS + +| Extension name | Description | Applicable for | Default value | +| -------------- | ----------- | -------------- | ------------- | +|x-all-of-name|Specify the name of the generated allOf composed schema|MODEL|null| +|x-one-of-name|Specify the name of the generated oneOf composed schema|MODEL|null| +|x-is-one-of-interface|Generate the oneOf composed schema as a marker interface|MODEL|null| + + ## IMPORT MAPPING | Type/Alias | Imports | diff --git a/docs/generators/eiffel.md b/docs/generators/eiffel.md index ff72e722de9877b2e9f231e0ca0c451f3b667a74..158815da605730372a4ca53d5a9e13fc0a732402 100644 --- a/docs/generators/eiffel.md +++ b/docs/generators/eiffel.md @@ -22,6 +22,15 @@ These options may be applied as additional-properties (cli) or configOptions (pl |packageName|Eiffel Cluster name (convention: lowercase).| |openapi| |packageVersion|Eiffel package version.| |1.0.0| +## SUPPORTED VENDOR EXTENSIONS + +| Extension name | Description | Applicable for | Default value | +| -------------- | ----------- | -------------- | ------------- | +|x-all-of-name|Specify the name of the generated allOf composed schema|MODEL|null| +|x-one-of-name|Specify the name of the generated oneOf composed schema|MODEL|null| +|x-is-one-of-interface|Generate the oneOf composed schema as a marker interface|MODEL|null| + + ## IMPORT MAPPING | Type/Alias | Imports | diff --git a/docs/generators/elixir.md b/docs/generators/elixir.md index 6bd748e76aee1181fbe5b50eb9321e1360e61864..031739ebf83c161099e06bb2b8d598bf34a84ec9 100644 --- a/docs/generators/elixir.md +++ b/docs/generators/elixir.md @@ -30,6 +30,15 @@ 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| +## SUPPORTED VENDOR EXTENSIONS + +| Extension name | Description | Applicable for | Default value | +| -------------- | ----------- | -------------- | ------------- | +|x-all-of-name|Specify the name of the generated allOf composed schema|MODEL|null| +|x-one-of-name|Specify the name of the generated oneOf composed schema|MODEL|null| +|x-is-one-of-interface|Generate the oneOf composed schema as a marker interface|MODEL|null| + + ## IMPORT MAPPING | Type/Alias | Imports | diff --git a/docs/generators/elm.md b/docs/generators/elm.md index 78b5e8ef63e2722a054452f7614bf305b60cb918..2848223184a741a22a35f58f21391e1e81135c92 100644 --- a/docs/generators/elm.md +++ b/docs/generators/elm.md @@ -19,6 +19,15 @@ These options may be applied as additional-properties (cli) or configOptions (pl | Option | Description | Values | Default | | ------ | ----------- | ------ | ------- | +## SUPPORTED VENDOR EXTENSIONS + +| Extension name | Description | Applicable for | Default value | +| -------------- | ----------- | -------------- | ------------- | +|x-all-of-name|Specify the name of the generated allOf composed schema|MODEL|null| +|x-one-of-name|Specify the name of the generated oneOf composed schema|MODEL|null| +|x-is-one-of-interface|Generate the oneOf composed schema as a marker interface|MODEL|null| + + ## IMPORT MAPPING | Type/Alias | Imports | diff --git a/docs/generators/erlang-client.md b/docs/generators/erlang-client.md index f1708efec379c3714696a0b0bbb30b3f6d93d8bf..1cb50619ecfe7ad9da0d27ecbdac227bf62a551c 100644 --- a/docs/generators/erlang-client.md +++ b/docs/generators/erlang-client.md @@ -21,6 +21,15 @@ These options may be applied as additional-properties (cli) or configOptions (pl |packageName|Erlang application name (convention: lowercase).| |openapi| |packageVersion|Erlang application version| |1.0.0| +## SUPPORTED VENDOR EXTENSIONS + +| Extension name | Description | Applicable for | Default value | +| -------------- | ----------- | -------------- | ------------- | +|x-all-of-name|Specify the name of the generated allOf composed schema|MODEL|null| +|x-one-of-name|Specify the name of the generated oneOf composed schema|MODEL|null| +|x-is-one-of-interface|Generate the oneOf composed schema as a marker interface|MODEL|null| + + ## IMPORT MAPPING | Type/Alias | Imports | diff --git a/docs/generators/erlang-proper.md b/docs/generators/erlang-proper.md index ead391057ce0eb9ba2d5f235a29b90c5c2cc15f8..35e52d0605080904422e282979cdf942c13be8ad 100644 --- a/docs/generators/erlang-proper.md +++ b/docs/generators/erlang-proper.md @@ -21,6 +21,15 @@ These options may be applied as additional-properties (cli) or configOptions (pl |packageName|Erlang application name (convention: lowercase).| |openapi| |packageVersion|Erlang application version| |1.0.0| +## SUPPORTED VENDOR EXTENSIONS + +| Extension name | Description | Applicable for | Default value | +| -------------- | ----------- | -------------- | ------------- | +|x-all-of-name|Specify the name of the generated allOf composed schema|MODEL|null| +|x-one-of-name|Specify the name of the generated oneOf composed schema|MODEL|null| +|x-is-one-of-interface|Generate the oneOf composed schema as a marker interface|MODEL|null| + + ## IMPORT MAPPING | Type/Alias | Imports | diff --git a/docs/generators/erlang-server.md b/docs/generators/erlang-server.md index 944c2be8cedf5bdaf4abac41be5cca3fb65d9f43..6f45a0d96a24c536dba8a8d75a95a9ec926ace8c 100644 --- a/docs/generators/erlang-server.md +++ b/docs/generators/erlang-server.md @@ -21,6 +21,15 @@ These options may be applied as additional-properties (cli) or configOptions (pl |openAPISpecName|Openapi Spec Name.| |openapi| |packageName|Erlang package name (convention: lowercase).| |openapi| +## SUPPORTED VENDOR EXTENSIONS + +| Extension name | Description | Applicable for | Default value | +| -------------- | ----------- | -------------- | ------------- | +|x-all-of-name|Specify the name of the generated allOf composed schema|MODEL|null| +|x-one-of-name|Specify the name of the generated oneOf composed schema|MODEL|null| +|x-is-one-of-interface|Generate the oneOf composed schema as a marker interface|MODEL|null| + + ## IMPORT MAPPING | Type/Alias | Imports | diff --git a/docs/generators/fsharp-functions.md b/docs/generators/fsharp-functions.md index dbb88f99e33f5c6b459c603a7acdec8545b478ae..87be958efccc440bbf8c4a781680959fd4274676 100644 --- a/docs/generators/fsharp-functions.md +++ b/docs/generators/fsharp-functions.md @@ -36,6 +36,15 @@ 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| |OpenAPI/src| +## SUPPORTED VENDOR EXTENSIONS + +| Extension name | Description | Applicable for | Default value | +| -------------- | ----------- | -------------- | ------------- | +|x-all-of-name|Specify the name of the generated allOf composed schema|MODEL|null| +|x-one-of-name|Specify the name of the generated oneOf composed schema|MODEL|null| +|x-is-one-of-interface|Generate the oneOf composed schema as a marker interface|MODEL|null| + + ## IMPORT MAPPING | Type/Alias | Imports | diff --git a/docs/generators/fsharp-giraffe-server.md b/docs/generators/fsharp-giraffe-server.md index 8c98bc32942c0e0e6851b601c2ae276b3d8f20c0..16f2ce783936ecbdb649eef49dea5579ce7d54bb 100644 --- a/docs/generators/fsharp-giraffe-server.md +++ b/docs/generators/fsharp-giraffe-server.md @@ -35,6 +35,15 @@ These options may be applied as additional-properties (cli) or configOptions (pl |useDateTimeOffset|Use DateTimeOffset to model date-time properties| |false| |useSwashbuckle|Uses the Swashbuckle.AspNetCore NuGet package for documentation.| |false| +## SUPPORTED VENDOR EXTENSIONS + +| Extension name | Description | Applicable for | Default value | +| -------------- | ----------- | -------------- | ------------- | +|x-all-of-name|Specify the name of the generated allOf composed schema|MODEL|null| +|x-one-of-name|Specify the name of the generated oneOf composed schema|MODEL|null| +|x-is-one-of-interface|Generate the oneOf composed schema as a marker interface|MODEL|null| + + ## IMPORT MAPPING | Type/Alias | Imports | diff --git a/docs/generators/go-echo-server.md b/docs/generators/go-echo-server.md index 7e638bc7c6734106b68b84b3caa093a71f806b80..5940699d086193682ca9c1dbac404d00c10bcbcd 100644 --- a/docs/generators/go-echo-server.md +++ b/docs/generators/go-echo-server.md @@ -23,6 +23,15 @@ These options may be applied as additional-properties (cli) or configOptions (pl |packageVersion|Go package version.| |1.0.0| |serverPort|The network port the generated server binds to| |8080| +## SUPPORTED VENDOR EXTENSIONS + +| Extension name | Description | Applicable for | Default value | +| -------------- | ----------- | -------------- | ------------- | +|x-all-of-name|Specify the name of the generated allOf composed schema|MODEL|null| +|x-one-of-name|Specify the name of the generated oneOf composed schema|MODEL|null| +|x-is-one-of-interface|Generate the oneOf composed schema as a marker interface|MODEL|null| + + ## IMPORT MAPPING | Type/Alias | Imports | diff --git a/docs/generators/go-gin-server.md b/docs/generators/go-gin-server.md index 035d0bfeda3ad8c4fe9f608d4aab6b23d90fb350..6e8894ee1ac95d8d89da45b207537a9f354255b1 100644 --- a/docs/generators/go-gin-server.md +++ b/docs/generators/go-gin-server.md @@ -25,6 +25,15 @@ These options may be applied as additional-properties (cli) or configOptions (pl |packageVersion|Go package version.| |1.0.0| |serverPort|The network port the generated server binds to| |8080| +## SUPPORTED VENDOR EXTENSIONS + +| Extension name | Description | Applicable for | Default value | +| -------------- | ----------- | -------------- | ------------- | +|x-all-of-name|Specify the name of the generated allOf composed schema|MODEL|null| +|x-one-of-name|Specify the name of the generated oneOf composed schema|MODEL|null| +|x-is-one-of-interface|Generate the oneOf composed schema as a marker interface|MODEL|null| + + ## IMPORT MAPPING | Type/Alias | Imports | diff --git a/docs/generators/go-server.md b/docs/generators/go-server.md index a4fe043431a50ff937a400528472cde931280df4..115ba5d1ac11f7d593c744f2265661829633c605 100644 --- a/docs/generators/go-server.md +++ b/docs/generators/go-server.md @@ -30,6 +30,15 @@ These options may be applied as additional-properties (cli) or configOptions (pl |serverPort|The network port the generated server binds to| |8080| |sourceFolder|source folder for generated code| |go| +## SUPPORTED VENDOR EXTENSIONS + +| Extension name | Description | Applicable for | Default value | +| -------------- | ----------- | -------------- | ------------- | +|x-all-of-name|Specify the name of the generated allOf composed schema|MODEL|null| +|x-one-of-name|Specify the name of the generated oneOf composed schema|MODEL|null| +|x-is-one-of-interface|Generate the oneOf composed schema as a marker interface|MODEL|null| + + ## IMPORT MAPPING | Type/Alias | Imports | diff --git a/docs/generators/go.md b/docs/generators/go.md index 782f6f05abdaf98693c5b7da6515ae2a4ee4012c..27a5065cad4beb0642883448d481ba9409ef04f2 100644 --- a/docs/generators/go.md +++ b/docs/generators/go.md @@ -31,6 +31,15 @@ These options may be applied as additional-properties (cli) or configOptions (pl |withAWSV4Signature|whether to include AWS v4 signature support| |false| |withXml|whether to include support for application/xml content type and include XML annotations in the model (works with libraries that provide support for JSON and XML)| |false| +## SUPPORTED VENDOR EXTENSIONS + +| Extension name | Description | Applicable for | Default value | +| -------------- | ----------- | -------------- | ------------- | +|x-all-of-name|Specify the name of the generated allOf composed schema|MODEL|null| +|x-one-of-name|Specify the name of the generated oneOf composed schema|MODEL|null| +|x-is-one-of-interface|Generate the oneOf composed schema as a marker interface|MODEL|null| + + ## IMPORT MAPPING | Type/Alias | Imports | diff --git a/docs/generators/graphql-nodejs-express-server.md b/docs/generators/graphql-nodejs-express-server.md index a1ab7ae06e9e785733419fcf4c42255de31a9ab7..7d817cb96c47295251ad90840936562d9ee2ca35 100644 --- a/docs/generators/graphql-nodejs-express-server.md +++ b/docs/generators/graphql-nodejs-express-server.md @@ -22,6 +22,15 @@ These options may be applied as additional-properties (cli) or configOptions (pl |packageName|GraphQL Node.js Express server package name (convention: lowercase).| |openapi3graphql-server| |packageVersion|GraphQL Node.js Express server package version.| |1.0.0| +## SUPPORTED VENDOR EXTENSIONS + +| Extension name | Description | Applicable for | Default value | +| -------------- | ----------- | -------------- | ------------- | +|x-all-of-name|Specify the name of the generated allOf composed schema|MODEL|null| +|x-one-of-name|Specify the name of the generated oneOf composed schema|MODEL|null| +|x-is-one-of-interface|Generate the oneOf composed schema as a marker interface|MODEL|null| + + ## IMPORT MAPPING | Type/Alias | Imports | diff --git a/docs/generators/graphql-schema.md b/docs/generators/graphql-schema.md index 84837ae7c6f543fbb729b4e04c2f8f0eccddda9e..2957d1b5ae9ee9bf67cff727737dccdbd903d52b 100644 --- a/docs/generators/graphql-schema.md +++ b/docs/generators/graphql-schema.md @@ -22,6 +22,15 @@ These options may be applied as additional-properties (cli) or configOptions (pl |packageName|GraphQL package name (convention: lowercase).| |openapi2graphql| |packageVersion|GraphQL package version.| |1.0.0| +## SUPPORTED VENDOR EXTENSIONS + +| Extension name | Description | Applicable for | Default value | +| -------------- | ----------- | -------------- | ------------- | +|x-all-of-name|Specify the name of the generated allOf composed schema|MODEL|null| +|x-one-of-name|Specify the name of the generated oneOf composed schema|MODEL|null| +|x-is-one-of-interface|Generate the oneOf composed schema as a marker interface|MODEL|null| + + ## IMPORT MAPPING | Type/Alias | Imports | diff --git a/docs/generators/groovy.md b/docs/generators/groovy.md index 5601e929430ff165ec4a458cca74e27b49b77d1f..668935db4b1708c27f65693428158bb4b61df0cd 100644 --- a/docs/generators/groovy.md +++ b/docs/generators/groovy.md @@ -67,14 +67,17 @@ These options may be applied as additional-properties (cli) or configOptions (pl | Extension name | Description | Applicable for | Default value | | -------------- | ----------- | -------------- | ------------- | -|x-discriminator-value|Used with model inheritance to specify value for discriminator that identifies current model|MODEL| -|x-implements|Ability to specify interfaces that model must implements|MODEL|empty array -|x-setter-extra-annotation|Custom annotation that can be specified over java setter for specific field|FIELD|When field is array & uniqueItems, then this extension is used to add `@JsonDeserialize(as = LinkedHashSet.class)` over setter, otherwise no value -|x-tags|Specify multiple swagger tags for operation|OPERATION|null -|x-accepts|Specify custom value for 'Accept' header for operation|OPERATION|null -|x-content-type|Specify custom value for 'Content-Type' header for operation|OPERATION|null -|x-class-extra-annotation|List of custom annotations to be added to model|MODEL|null -|x-field-extra-annotation|List of custom annotations to be added to property|FIELD|null +|x-all-of-name|Specify the name of the generated allOf composed schema|MODEL|null| +|x-one-of-name|Specify the name of the generated oneOf composed schema|MODEL|null| +|x-is-one-of-interface|Generate the oneOf composed schema as a marker interface|MODEL|null| +|x-discriminator-value|Used with model inheritance to specify value for discriminator that identifies current model|MODEL|| +|x-implements|Ability to specify interfaces that model must implements|MODEL|empty array| +|x-setter-extra-annotation|Custom annotation that can be specified over java setter for specific field|FIELD|When field is array & uniqueItems, then this extension is used to add `@JsonDeserialize(as = LinkedHashSet.class)` over setter, otherwise no value| +|x-tags|Specify multiple swagger tags for operation|OPERATION|null| +|x-accepts|Specify custom value for 'Accept' header for operation|OPERATION|null| +|x-content-type|Specify custom value for 'Content-Type' header for operation|OPERATION|null| +|x-class-extra-annotation|List of custom annotations to be added to model|MODEL|null| +|x-field-extra-annotation|List of custom annotations to be added to property|FIELD|null| ## IMPORT MAPPING diff --git a/docs/generators/haskell-http-client.md b/docs/generators/haskell-http-client.md index 50fe695fa919a51a5694055d0e6e273e393373b8..43c7a77777d55cfaf2efe5d5ce7fa34d6a96aa9f 100644 --- a/docs/generators/haskell-http-client.md +++ b/docs/generators/haskell-http-client.md @@ -49,6 +49,15 @@ These options may be applied as additional-properties (cli) or configOptions (pl |strictFields|Add strictness annotations to all model fields| |true| |useKatip|Sets the default value for the UseKatip cabal flag. If true, the katip package provides logging instead of monad-logger| |true| +## SUPPORTED VENDOR EXTENSIONS + +| Extension name | Description | Applicable for | Default value | +| -------------- | ----------- | -------------- | ------------- | +|x-all-of-name|Specify the name of the generated allOf composed schema|MODEL|null| +|x-one-of-name|Specify the name of the generated oneOf composed schema|MODEL|null| +|x-is-one-of-interface|Generate the oneOf composed schema as a marker interface|MODEL|null| + + ## IMPORT MAPPING | Type/Alias | Imports | diff --git a/docs/generators/haskell-yesod.md b/docs/generators/haskell-yesod.md index fcb8ce3d49c313ebed17bfe7e1663e23e813f390..08de181654613edb55e1eabc2c789c49be9cb44a 100644 --- a/docs/generators/haskell-yesod.md +++ b/docs/generators/haskell-yesod.md @@ -29,6 +29,15 @@ 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| +## SUPPORTED VENDOR EXTENSIONS + +| Extension name | Description | Applicable for | Default value | +| -------------- | ----------- | -------------- | ------------- | +|x-all-of-name|Specify the name of the generated allOf composed schema|MODEL|null| +|x-one-of-name|Specify the name of the generated oneOf composed schema|MODEL|null| +|x-is-one-of-interface|Generate the oneOf composed schema as a marker interface|MODEL|null| + + ## IMPORT MAPPING | Type/Alias | Imports | diff --git a/docs/generators/haskell.md b/docs/generators/haskell.md index 4ac8e5c7fbf1f1b4ecdc89c1dafcc4b541c681a9..87415f8abdd436cae826da271ec8530b15ecedc5 100644 --- a/docs/generators/haskell.md +++ b/docs/generators/haskell.md @@ -30,6 +30,15 @@ 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| +## SUPPORTED VENDOR EXTENSIONS + +| Extension name | Description | Applicable for | Default value | +| -------------- | ----------- | -------------- | ------------- | +|x-all-of-name|Specify the name of the generated allOf composed schema|MODEL|null| +|x-one-of-name|Specify the name of the generated oneOf composed schema|MODEL|null| +|x-is-one-of-interface|Generate the oneOf composed schema as a marker interface|MODEL|null| + + ## IMPORT MAPPING | Type/Alias | Imports | diff --git a/docs/generators/html.md b/docs/generators/html.md index fe176f2cc7322ca72d368cc2427fd96e46bf224f..5d00228bf1dfd14a5e97c61dcc8e8d546daa6b5d 100644 --- a/docs/generators/html.md +++ b/docs/generators/html.md @@ -36,6 +36,15 @@ 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| +## SUPPORTED VENDOR EXTENSIONS + +| Extension name | Description | Applicable for | Default value | +| -------------- | ----------- | -------------- | ------------- | +|x-all-of-name|Specify the name of the generated allOf composed schema|MODEL|null| +|x-one-of-name|Specify the name of the generated oneOf composed schema|MODEL|null| +|x-is-one-of-interface|Generate the oneOf composed schema as a marker interface|MODEL|null| + + ## IMPORT MAPPING | Type/Alias | Imports | diff --git a/docs/generators/html2.md b/docs/generators/html2.md index 92f3425056f596357a7962a48e42a101465f3939..3eb49e682b97f03e2ae996c9e282600e79b384e9 100644 --- a/docs/generators/html2.md +++ b/docs/generators/html2.md @@ -40,6 +40,15 @@ 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| +## SUPPORTED VENDOR EXTENSIONS + +| Extension name | Description | Applicable for | Default value | +| -------------- | ----------- | -------------- | ------------- | +|x-all-of-name|Specify the name of the generated allOf composed schema|MODEL|null| +|x-one-of-name|Specify the name of the generated oneOf composed schema|MODEL|null| +|x-is-one-of-interface|Generate the oneOf composed schema as a marker interface|MODEL|null| + + ## IMPORT MAPPING | Type/Alias | Imports | diff --git a/docs/generators/java-camel.md b/docs/generators/java-camel.md index 4c767788b96b6abe8e3eba0515ae3ce6950ea78f..c49f55d2bc8a7b4fca1f9431ca7ded0222240e50 100644 --- a/docs/generators/java-camel.md +++ b/docs/generators/java-camel.md @@ -100,15 +100,18 @@ These options may be applied as additional-properties (cli) or configOptions (pl | Extension name | Description | Applicable for | Default value | | -------------- | ----------- | -------------- | ------------- | -|x-discriminator-value|Used with model inheritance to specify value for discriminator that identifies current model|MODEL| -|x-implements|Ability to specify interfaces that model must implements|MODEL|empty array -|x-setter-extra-annotation|Custom annotation that can be specified over java setter for specific field|FIELD|When field is array & uniqueItems, then this extension is used to add `@JsonDeserialize(as = LinkedHashSet.class)` over setter, otherwise no value -|x-tags|Specify multiple swagger tags for operation|OPERATION|null -|x-accepts|Specify custom value for 'Accept' header for operation|OPERATION|null -|x-content-type|Specify custom value for 'Content-Type' header for operation|OPERATION|null -|x-class-extra-annotation|List of custom annotations to be added to model|MODEL|null -|x-field-extra-annotation|List of custom annotations to be added to property|FIELD|null -|x-spring-paginated|Add org.springframework.data.domain.Pageable to controller method. Can be used to handle page & size query parameters|OPERATION|false +|x-all-of-name|Specify the name of the generated allOf composed schema|MODEL|null| +|x-one-of-name|Specify the name of the generated oneOf composed schema|MODEL|null| +|x-is-one-of-interface|Generate the oneOf composed schema as a marker interface|MODEL|null| +|x-discriminator-value|Used with model inheritance to specify value for discriminator that identifies current model|MODEL|| +|x-implements|Ability to specify interfaces that model must implements|MODEL|empty array| +|x-setter-extra-annotation|Custom annotation that can be specified over java setter for specific field|FIELD|When field is array & uniqueItems, then this extension is used to add `@JsonDeserialize(as = LinkedHashSet.class)` over setter, otherwise no value| +|x-tags|Specify multiple swagger tags for operation|OPERATION|null| +|x-accepts|Specify custom value for 'Accept' header for operation|OPERATION|null| +|x-content-type|Specify custom value for 'Content-Type' header for operation|OPERATION|null| +|x-class-extra-annotation|List of custom annotations to be added to model|MODEL|null| +|x-field-extra-annotation|List of custom annotations to be added to property|FIELD|null| +|x-spring-paginated|Add org.springframework.data.domain.Pageable to controller method. Can be used to handle page & size query parameters|OPERATION|false| ## IMPORT MAPPING diff --git a/docs/generators/java-inflector.md b/docs/generators/java-inflector.md index f5e7de1fbe9b3af532fa3cb95dc87d51dcbea04d..e28abe14db14ce5a3a0384c2a518d7706b54ee7c 100644 --- a/docs/generators/java-inflector.md +++ b/docs/generators/java-inflector.md @@ -69,14 +69,17 @@ These options may be applied as additional-properties (cli) or configOptions (pl | Extension name | Description | Applicable for | Default value | | -------------- | ----------- | -------------- | ------------- | -|x-discriminator-value|Used with model inheritance to specify value for discriminator that identifies current model|MODEL| -|x-implements|Ability to specify interfaces that model must implements|MODEL|empty array -|x-setter-extra-annotation|Custom annotation that can be specified over java setter for specific field|FIELD|When field is array & uniqueItems, then this extension is used to add `@JsonDeserialize(as = LinkedHashSet.class)` over setter, otherwise no value -|x-tags|Specify multiple swagger tags for operation|OPERATION|null -|x-accepts|Specify custom value for 'Accept' header for operation|OPERATION|null -|x-content-type|Specify custom value for 'Content-Type' header for operation|OPERATION|null -|x-class-extra-annotation|List of custom annotations to be added to model|MODEL|null -|x-field-extra-annotation|List of custom annotations to be added to property|FIELD|null +|x-all-of-name|Specify the name of the generated allOf composed schema|MODEL|null| +|x-one-of-name|Specify the name of the generated oneOf composed schema|MODEL|null| +|x-is-one-of-interface|Generate the oneOf composed schema as a marker interface|MODEL|null| +|x-discriminator-value|Used with model inheritance to specify value for discriminator that identifies current model|MODEL|| +|x-implements|Ability to specify interfaces that model must implements|MODEL|empty array| +|x-setter-extra-annotation|Custom annotation that can be specified over java setter for specific field|FIELD|When field is array & uniqueItems, then this extension is used to add `@JsonDeserialize(as = LinkedHashSet.class)` over setter, otherwise no value| +|x-tags|Specify multiple swagger tags for operation|OPERATION|null| +|x-accepts|Specify custom value for 'Accept' header for operation|OPERATION|null| +|x-content-type|Specify custom value for 'Content-Type' header for operation|OPERATION|null| +|x-class-extra-annotation|List of custom annotations to be added to model|MODEL|null| +|x-field-extra-annotation|List of custom annotations to be added to property|FIELD|null| ## IMPORT MAPPING diff --git a/docs/generators/java-micronaut-client.md b/docs/generators/java-micronaut-client.md index ac62abd17094c8ecd623a7a943913de96b32b2f8..42106e95c22d1568d49bee162656fdc83d205780 100644 --- a/docs/generators/java-micronaut-client.md +++ b/docs/generators/java-micronaut-client.md @@ -78,14 +78,17 @@ These options may be applied as additional-properties (cli) or configOptions (pl | Extension name | Description | Applicable for | Default value | | -------------- | ----------- | -------------- | ------------- | -|x-discriminator-value|Used with model inheritance to specify value for discriminator that identifies current model|MODEL| -|x-implements|Ability to specify interfaces that model must implements|MODEL|empty array -|x-setter-extra-annotation|Custom annotation that can be specified over java setter for specific field|FIELD|When field is array & uniqueItems, then this extension is used to add `@JsonDeserialize(as = LinkedHashSet.class)` over setter, otherwise no value -|x-tags|Specify multiple swagger tags for operation|OPERATION|null -|x-accepts|Specify custom value for 'Accept' header for operation|OPERATION|null -|x-content-type|Specify custom value for 'Content-Type' header for operation|OPERATION|null -|x-class-extra-annotation|List of custom annotations to be added to model|MODEL|null -|x-field-extra-annotation|List of custom annotations to be added to property|FIELD|null +|x-all-of-name|Specify the name of the generated allOf composed schema|MODEL|null| +|x-one-of-name|Specify the name of the generated oneOf composed schema|MODEL|null| +|x-is-one-of-interface|Generate the oneOf composed schema as a marker interface|MODEL|null| +|x-discriminator-value|Used with model inheritance to specify value for discriminator that identifies current model|MODEL|| +|x-implements|Ability to specify interfaces that model must implements|MODEL|empty array| +|x-setter-extra-annotation|Custom annotation that can be specified over java setter for specific field|FIELD|When field is array & uniqueItems, then this extension is used to add `@JsonDeserialize(as = LinkedHashSet.class)` over setter, otherwise no value| +|x-tags|Specify multiple swagger tags for operation|OPERATION|null| +|x-accepts|Specify custom value for 'Accept' header for operation|OPERATION|null| +|x-content-type|Specify custom value for 'Content-Type' header for operation|OPERATION|null| +|x-class-extra-annotation|List of custom annotations to be added to model|MODEL|null| +|x-field-extra-annotation|List of custom annotations to be added to property|FIELD|null| ## IMPORT MAPPING diff --git a/docs/generators/java-micronaut-server.md b/docs/generators/java-micronaut-server.md index a146585b20ce47944dc7e70f14233618c1adfd6b..6ead0d9a2ec81996ed95e04725a8a391a00f58a5 100644 --- a/docs/generators/java-micronaut-server.md +++ b/docs/generators/java-micronaut-server.md @@ -80,14 +80,17 @@ These options may be applied as additional-properties (cli) or configOptions (pl | Extension name | Description | Applicable for | Default value | | -------------- | ----------- | -------------- | ------------- | -|x-discriminator-value|Used with model inheritance to specify value for discriminator that identifies current model|MODEL| -|x-implements|Ability to specify interfaces that model must implements|MODEL|empty array -|x-setter-extra-annotation|Custom annotation that can be specified over java setter for specific field|FIELD|When field is array & uniqueItems, then this extension is used to add `@JsonDeserialize(as = LinkedHashSet.class)` over setter, otherwise no value -|x-tags|Specify multiple swagger tags for operation|OPERATION|null -|x-accepts|Specify custom value for 'Accept' header for operation|OPERATION|null -|x-content-type|Specify custom value for 'Content-Type' header for operation|OPERATION|null -|x-class-extra-annotation|List of custom annotations to be added to model|MODEL|null -|x-field-extra-annotation|List of custom annotations to be added to property|FIELD|null +|x-all-of-name|Specify the name of the generated allOf composed schema|MODEL|null| +|x-one-of-name|Specify the name of the generated oneOf composed schema|MODEL|null| +|x-is-one-of-interface|Generate the oneOf composed schema as a marker interface|MODEL|null| +|x-discriminator-value|Used with model inheritance to specify value for discriminator that identifies current model|MODEL|| +|x-implements|Ability to specify interfaces that model must implements|MODEL|empty array| +|x-setter-extra-annotation|Custom annotation that can be specified over java setter for specific field|FIELD|When field is array & uniqueItems, then this extension is used to add `@JsonDeserialize(as = LinkedHashSet.class)` over setter, otherwise no value| +|x-tags|Specify multiple swagger tags for operation|OPERATION|null| +|x-accepts|Specify custom value for 'Accept' header for operation|OPERATION|null| +|x-content-type|Specify custom value for 'Content-Type' header for operation|OPERATION|null| +|x-class-extra-annotation|List of custom annotations to be added to model|MODEL|null| +|x-field-extra-annotation|List of custom annotations to be added to property|FIELD|null| ## IMPORT MAPPING diff --git a/docs/generators/java-msf4j.md b/docs/generators/java-msf4j.md index e79e48e357a3eb163daac8f2e861398c36e95fef..16f54ac2c4936593c563232561612fc7514dab98 100644 --- a/docs/generators/java-msf4j.md +++ b/docs/generators/java-msf4j.md @@ -75,14 +75,17 @@ These options may be applied as additional-properties (cli) or configOptions (pl | Extension name | Description | Applicable for | Default value | | -------------- | ----------- | -------------- | ------------- | -|x-discriminator-value|Used with model inheritance to specify value for discriminator that identifies current model|MODEL| -|x-implements|Ability to specify interfaces that model must implements|MODEL|empty array -|x-setter-extra-annotation|Custom annotation that can be specified over java setter for specific field|FIELD|When field is array & uniqueItems, then this extension is used to add `@JsonDeserialize(as = LinkedHashSet.class)` over setter, otherwise no value -|x-tags|Specify multiple swagger tags for operation|OPERATION|null -|x-accepts|Specify custom value for 'Accept' header for operation|OPERATION|null -|x-content-type|Specify custom value for 'Content-Type' header for operation|OPERATION|null -|x-class-extra-annotation|List of custom annotations to be added to model|MODEL|null -|x-field-extra-annotation|List of custom annotations to be added to property|FIELD|null +|x-all-of-name|Specify the name of the generated allOf composed schema|MODEL|null| +|x-one-of-name|Specify the name of the generated oneOf composed schema|MODEL|null| +|x-is-one-of-interface|Generate the oneOf composed schema as a marker interface|MODEL|null| +|x-discriminator-value|Used with model inheritance to specify value for discriminator that identifies current model|MODEL|| +|x-implements|Ability to specify interfaces that model must implements|MODEL|empty array| +|x-setter-extra-annotation|Custom annotation that can be specified over java setter for specific field|FIELD|When field is array & uniqueItems, then this extension is used to add `@JsonDeserialize(as = LinkedHashSet.class)` over setter, otherwise no value| +|x-tags|Specify multiple swagger tags for operation|OPERATION|null| +|x-accepts|Specify custom value for 'Accept' header for operation|OPERATION|null| +|x-content-type|Specify custom value for 'Content-Type' header for operation|OPERATION|null| +|x-class-extra-annotation|List of custom annotations to be added to model|MODEL|null| +|x-field-extra-annotation|List of custom annotations to be added to property|FIELD|null| ## IMPORT MAPPING diff --git a/docs/generators/java-pkmst.md b/docs/generators/java-pkmst.md index a00faea8198dd67a625b98e56683c8a1a45a5368..e302bf693dd8429c0acb8103a787288c085783cf 100644 --- a/docs/generators/java-pkmst.md +++ b/docs/generators/java-pkmst.md @@ -76,14 +76,17 @@ These options may be applied as additional-properties (cli) or configOptions (pl | Extension name | Description | Applicable for | Default value | | -------------- | ----------- | -------------- | ------------- | -|x-discriminator-value|Used with model inheritance to specify value for discriminator that identifies current model|MODEL| -|x-implements|Ability to specify interfaces that model must implements|MODEL|empty array -|x-setter-extra-annotation|Custom annotation that can be specified over java setter for specific field|FIELD|When field is array & uniqueItems, then this extension is used to add `@JsonDeserialize(as = LinkedHashSet.class)` over setter, otherwise no value -|x-tags|Specify multiple swagger tags for operation|OPERATION|null -|x-accepts|Specify custom value for 'Accept' header for operation|OPERATION|null -|x-content-type|Specify custom value for 'Content-Type' header for operation|OPERATION|null -|x-class-extra-annotation|List of custom annotations to be added to model|MODEL|null -|x-field-extra-annotation|List of custom annotations to be added to property|FIELD|null +|x-all-of-name|Specify the name of the generated allOf composed schema|MODEL|null| +|x-one-of-name|Specify the name of the generated oneOf composed schema|MODEL|null| +|x-is-one-of-interface|Generate the oneOf composed schema as a marker interface|MODEL|null| +|x-discriminator-value|Used with model inheritance to specify value for discriminator that identifies current model|MODEL|| +|x-implements|Ability to specify interfaces that model must implements|MODEL|empty array| +|x-setter-extra-annotation|Custom annotation that can be specified over java setter for specific field|FIELD|When field is array & uniqueItems, then this extension is used to add `@JsonDeserialize(as = LinkedHashSet.class)` over setter, otherwise no value| +|x-tags|Specify multiple swagger tags for operation|OPERATION|null| +|x-accepts|Specify custom value for 'Accept' header for operation|OPERATION|null| +|x-content-type|Specify custom value for 'Content-Type' header for operation|OPERATION|null| +|x-class-extra-annotation|List of custom annotations to be added to model|MODEL|null| +|x-field-extra-annotation|List of custom annotations to be added to property|FIELD|null| ## IMPORT MAPPING diff --git a/docs/generators/java-play-framework.md b/docs/generators/java-play-framework.md index 2b8e848307ecc250e87ae69cf75814aa1ae04196..259433bb46e87a5e88ec771f6ddf852cff272bcf 100644 --- a/docs/generators/java-play-framework.md +++ b/docs/generators/java-play-framework.md @@ -79,14 +79,17 @@ These options may be applied as additional-properties (cli) or configOptions (pl | Extension name | Description | Applicable for | Default value | | -------------- | ----------- | -------------- | ------------- | -|x-discriminator-value|Used with model inheritance to specify value for discriminator that identifies current model|MODEL| -|x-implements|Ability to specify interfaces that model must implements|MODEL|empty array -|x-setter-extra-annotation|Custom annotation that can be specified over java setter for specific field|FIELD|When field is array & uniqueItems, then this extension is used to add `@JsonDeserialize(as = LinkedHashSet.class)` over setter, otherwise no value -|x-tags|Specify multiple swagger tags for operation|OPERATION|null -|x-accepts|Specify custom value for 'Accept' header for operation|OPERATION|null -|x-content-type|Specify custom value for 'Content-Type' header for operation|OPERATION|null -|x-class-extra-annotation|List of custom annotations to be added to model|MODEL|null -|x-field-extra-annotation|List of custom annotations to be added to property|FIELD|null +|x-all-of-name|Specify the name of the generated allOf composed schema|MODEL|null| +|x-one-of-name|Specify the name of the generated oneOf composed schema|MODEL|null| +|x-is-one-of-interface|Generate the oneOf composed schema as a marker interface|MODEL|null| +|x-discriminator-value|Used with model inheritance to specify value for discriminator that identifies current model|MODEL|| +|x-implements|Ability to specify interfaces that model must implements|MODEL|empty array| +|x-setter-extra-annotation|Custom annotation that can be specified over java setter for specific field|FIELD|When field is array & uniqueItems, then this extension is used to add `@JsonDeserialize(as = LinkedHashSet.class)` over setter, otherwise no value| +|x-tags|Specify multiple swagger tags for operation|OPERATION|null| +|x-accepts|Specify custom value for 'Accept' header for operation|OPERATION|null| +|x-content-type|Specify custom value for 'Content-Type' header for operation|OPERATION|null| +|x-class-extra-annotation|List of custom annotations to be added to model|MODEL|null| +|x-field-extra-annotation|List of custom annotations to be added to property|FIELD|null| ## IMPORT MAPPING diff --git a/docs/generators/java-undertow-server.md b/docs/generators/java-undertow-server.md index 7acdd544bfdf7202dcd2c575738e2aa1ae526dc1..e238aa703e822b8d61db2352baf6e38a2c4ac69d 100644 --- a/docs/generators/java-undertow-server.md +++ b/docs/generators/java-undertow-server.md @@ -69,14 +69,17 @@ These options may be applied as additional-properties (cli) or configOptions (pl | Extension name | Description | Applicable for | Default value | | -------------- | ----------- | -------------- | ------------- | -|x-discriminator-value|Used with model inheritance to specify value for discriminator that identifies current model|MODEL| -|x-implements|Ability to specify interfaces that model must implements|MODEL|empty array -|x-setter-extra-annotation|Custom annotation that can be specified over java setter for specific field|FIELD|When field is array & uniqueItems, then this extension is used to add `@JsonDeserialize(as = LinkedHashSet.class)` over setter, otherwise no value -|x-tags|Specify multiple swagger tags for operation|OPERATION|null -|x-accepts|Specify custom value for 'Accept' header for operation|OPERATION|null -|x-content-type|Specify custom value for 'Content-Type' header for operation|OPERATION|null -|x-class-extra-annotation|List of custom annotations to be added to model|MODEL|null -|x-field-extra-annotation|List of custom annotations to be added to property|FIELD|null +|x-all-of-name|Specify the name of the generated allOf composed schema|MODEL|null| +|x-one-of-name|Specify the name of the generated oneOf composed schema|MODEL|null| +|x-is-one-of-interface|Generate the oneOf composed schema as a marker interface|MODEL|null| +|x-discriminator-value|Used with model inheritance to specify value for discriminator that identifies current model|MODEL|| +|x-implements|Ability to specify interfaces that model must implements|MODEL|empty array| +|x-setter-extra-annotation|Custom annotation that can be specified over java setter for specific field|FIELD|When field is array & uniqueItems, then this extension is used to add `@JsonDeserialize(as = LinkedHashSet.class)` over setter, otherwise no value| +|x-tags|Specify multiple swagger tags for operation|OPERATION|null| +|x-accepts|Specify custom value for 'Accept' header for operation|OPERATION|null| +|x-content-type|Specify custom value for 'Content-Type' header for operation|OPERATION|null| +|x-class-extra-annotation|List of custom annotations to be added to model|MODEL|null| +|x-field-extra-annotation|List of custom annotations to be added to property|FIELD|null| ## IMPORT MAPPING diff --git a/docs/generators/java-vertx-web.md b/docs/generators/java-vertx-web.md index 1db231f7d8f7f341e09d7211e834186d37e37796..4faccb118e5ee6c0a597a84454d7f80565567113 100644 --- a/docs/generators/java-vertx-web.md +++ b/docs/generators/java-vertx-web.md @@ -69,14 +69,17 @@ These options may be applied as additional-properties (cli) or configOptions (pl | Extension name | Description | Applicable for | Default value | | -------------- | ----------- | -------------- | ------------- | -|x-discriminator-value|Used with model inheritance to specify value for discriminator that identifies current model|MODEL| -|x-implements|Ability to specify interfaces that model must implements|MODEL|empty array -|x-setter-extra-annotation|Custom annotation that can be specified over java setter for specific field|FIELD|When field is array & uniqueItems, then this extension is used to add `@JsonDeserialize(as = LinkedHashSet.class)` over setter, otherwise no value -|x-tags|Specify multiple swagger tags for operation|OPERATION|null -|x-accepts|Specify custom value for 'Accept' header for operation|OPERATION|null -|x-content-type|Specify custom value for 'Content-Type' header for operation|OPERATION|null -|x-class-extra-annotation|List of custom annotations to be added to model|MODEL|null -|x-field-extra-annotation|List of custom annotations to be added to property|FIELD|null +|x-all-of-name|Specify the name of the generated allOf composed schema|MODEL|null| +|x-one-of-name|Specify the name of the generated oneOf composed schema|MODEL|null| +|x-is-one-of-interface|Generate the oneOf composed schema as a marker interface|MODEL|null| +|x-discriminator-value|Used with model inheritance to specify value for discriminator that identifies current model|MODEL|| +|x-implements|Ability to specify interfaces that model must implements|MODEL|empty array| +|x-setter-extra-annotation|Custom annotation that can be specified over java setter for specific field|FIELD|When field is array & uniqueItems, then this extension is used to add `@JsonDeserialize(as = LinkedHashSet.class)` over setter, otherwise no value| +|x-tags|Specify multiple swagger tags for operation|OPERATION|null| +|x-accepts|Specify custom value for 'Accept' header for operation|OPERATION|null| +|x-content-type|Specify custom value for 'Content-Type' header for operation|OPERATION|null| +|x-class-extra-annotation|List of custom annotations to be added to model|MODEL|null| +|x-field-extra-annotation|List of custom annotations to be added to property|FIELD|null| ## IMPORT MAPPING diff --git a/docs/generators/java-vertx.md b/docs/generators/java-vertx.md index 82a9316778e26ccc7df38e2d5256cef08152513a..919378841d306597dd0e0ea684b97ad2ca546644 100644 --- a/docs/generators/java-vertx.md +++ b/docs/generators/java-vertx.md @@ -72,14 +72,17 @@ These options may be applied as additional-properties (cli) or configOptions (pl | Extension name | Description | Applicable for | Default value | | -------------- | ----------- | -------------- | ------------- | -|x-discriminator-value|Used with model inheritance to specify value for discriminator that identifies current model|MODEL| -|x-implements|Ability to specify interfaces that model must implements|MODEL|empty array -|x-setter-extra-annotation|Custom annotation that can be specified over java setter for specific field|FIELD|When field is array & uniqueItems, then this extension is used to add `@JsonDeserialize(as = LinkedHashSet.class)` over setter, otherwise no value -|x-tags|Specify multiple swagger tags for operation|OPERATION|null -|x-accepts|Specify custom value for 'Accept' header for operation|OPERATION|null -|x-content-type|Specify custom value for 'Content-Type' header for operation|OPERATION|null -|x-class-extra-annotation|List of custom annotations to be added to model|MODEL|null -|x-field-extra-annotation|List of custom annotations to be added to property|FIELD|null +|x-all-of-name|Specify the name of the generated allOf composed schema|MODEL|null| +|x-one-of-name|Specify the name of the generated oneOf composed schema|MODEL|null| +|x-is-one-of-interface|Generate the oneOf composed schema as a marker interface|MODEL|null| +|x-discriminator-value|Used with model inheritance to specify value for discriminator that identifies current model|MODEL|| +|x-implements|Ability to specify interfaces that model must implements|MODEL|empty array| +|x-setter-extra-annotation|Custom annotation that can be specified over java setter for specific field|FIELD|When field is array & uniqueItems, then this extension is used to add `@JsonDeserialize(as = LinkedHashSet.class)` over setter, otherwise no value| +|x-tags|Specify multiple swagger tags for operation|OPERATION|null| +|x-accepts|Specify custom value for 'Accept' header for operation|OPERATION|null| +|x-content-type|Specify custom value for 'Content-Type' header for operation|OPERATION|null| +|x-class-extra-annotation|List of custom annotations to be added to model|MODEL|null| +|x-field-extra-annotation|List of custom annotations to be added to property|FIELD|null| ## IMPORT MAPPING diff --git a/docs/generators/java.md b/docs/generators/java.md index 5184e5f56f7b2def6dff0b930032dccd55d27345..f68241e4e57638098028dc22a1680f6ce9985b56 100644 --- a/docs/generators/java.md +++ b/docs/generators/java.md @@ -90,15 +90,18 @@ These options may be applied as additional-properties (cli) or configOptions (pl | Extension name | Description | Applicable for | Default value | | -------------- | ----------- | -------------- | ------------- | -|x-discriminator-value|Used with model inheritance to specify value for discriminator that identifies current model|MODEL| -|x-implements|Ability to specify interfaces that model must implements|MODEL|empty array -|x-setter-extra-annotation|Custom annotation that can be specified over java setter for specific field|FIELD|When field is array & uniqueItems, then this extension is used to add `@JsonDeserialize(as = LinkedHashSet.class)` over setter, otherwise no value -|x-tags|Specify multiple swagger tags for operation|OPERATION|null -|x-accepts|Specify custom value for 'Accept' header for operation|OPERATION|null -|x-content-type|Specify custom value for 'Content-Type' header for operation|OPERATION|null -|x-class-extra-annotation|List of custom annotations to be added to model|MODEL|null -|x-field-extra-annotation|List of custom annotations to be added to property|FIELD|null -|x-webclient-blocking|Specifies if method for specific operation should be blocking or non-blocking(ex: return `Mono<T>/Flux<T>` or `return T/List<T>/Set<T>` & execute `.block()` inside generated method)|OPERATION|false +|x-all-of-name|Specify the name of the generated allOf composed schema|MODEL|null| +|x-one-of-name|Specify the name of the generated oneOf composed schema|MODEL|null| +|x-is-one-of-interface|Generate the oneOf composed schema as a marker interface|MODEL|null| +|x-discriminator-value|Used with model inheritance to specify value for discriminator that identifies current model|MODEL|| +|x-implements|Ability to specify interfaces that model must implements|MODEL|empty array| +|x-setter-extra-annotation|Custom annotation that can be specified over java setter for specific field|FIELD|When field is array & uniqueItems, then this extension is used to add `@JsonDeserialize(as = LinkedHashSet.class)` over setter, otherwise no value| +|x-tags|Specify multiple swagger tags for operation|OPERATION|null| +|x-accepts|Specify custom value for 'Accept' header for operation|OPERATION|null| +|x-content-type|Specify custom value for 'Content-Type' header for operation|OPERATION|null| +|x-class-extra-annotation|List of custom annotations to be added to model|MODEL|null| +|x-field-extra-annotation|List of custom annotations to be added to property|FIELD|null| +|x-webclient-blocking|Specifies if method for specific operation should be blocking or non-blocking(ex: return `Mono<T>/Flux<T>` or `return T/List<T>/Set<T>` & execute `.block()` inside generated method)|OPERATION|false| ## IMPORT MAPPING diff --git a/docs/generators/javascript-apollo.md b/docs/generators/javascript-apollo.md index e91486057e11334479a1050b9e77250ed10e41f9..1fd5a98dd7502242c3270633a222f401254780be 100644 --- a/docs/generators/javascript-apollo.md +++ b/docs/generators/javascript-apollo.md @@ -41,6 +41,15 @@ These options may be applied as additional-properties (cli) or configOptions (pl |sourceFolder|source folder for generated code| |src| |useInheritance|use JavaScript prototype chains & delegation for inheritance| |true| +## SUPPORTED VENDOR EXTENSIONS + +| Extension name | Description | Applicable for | Default value | +| -------------- | ----------- | -------------- | ------------- | +|x-all-of-name|Specify the name of the generated allOf composed schema|MODEL|null| +|x-one-of-name|Specify the name of the generated oneOf composed schema|MODEL|null| +|x-is-one-of-interface|Generate the oneOf composed schema as a marker interface|MODEL|null| + + ## IMPORT MAPPING | Type/Alias | Imports | diff --git a/docs/generators/javascript-closure-angular.md b/docs/generators/javascript-closure-angular.md index 2f78d0e865edcb575ea17f779bdc16a898331a90..86e337ff870a617753552f79ce6ea8f42727c1d5 100644 --- a/docs/generators/javascript-closure-angular.md +++ b/docs/generators/javascript-closure-angular.md @@ -29,6 +29,15 @@ These options may be applied as additional-properties (cli) or configOptions (pl |sortParamsByRequiredFlag|Sort method arguments to place required parameters before optional parameters.| |true| |useEs6|use ES6 templates| |false| +## SUPPORTED VENDOR EXTENSIONS + +| Extension name | Description | Applicable for | Default value | +| -------------- | ----------- | -------------- | ------------- | +|x-all-of-name|Specify the name of the generated allOf composed schema|MODEL|null| +|x-one-of-name|Specify the name of the generated oneOf composed schema|MODEL|null| +|x-is-one-of-interface|Generate the oneOf composed schema as a marker interface|MODEL|null| + + ## IMPORT MAPPING | Type/Alias | Imports | diff --git a/docs/generators/javascript-flowtyped.md b/docs/generators/javascript-flowtyped.md index 48e249aa7f61e27f1708bfda9bb8b9765907859e..35488266218c85e312980581ea0ea1df53aba254 100644 --- a/docs/generators/javascript-flowtyped.md +++ b/docs/generators/javascript-flowtyped.md @@ -37,6 +37,15 @@ These options may be applied as additional-properties (cli) or configOptions (pl |sortParamsByRequiredFlag|Sort method arguments to place required parameters before optional parameters.| |true| |supportsES6|Generate code that conforms to ES6.| |false| +## SUPPORTED VENDOR EXTENSIONS + +| Extension name | Description | Applicable for | Default value | +| -------------- | ----------- | -------------- | ------------- | +|x-all-of-name|Specify the name of the generated allOf composed schema|MODEL|null| +|x-one-of-name|Specify the name of the generated oneOf composed schema|MODEL|null| +|x-is-one-of-interface|Generate the oneOf composed schema as a marker interface|MODEL|null| + + ## IMPORT MAPPING | Type/Alias | Imports | diff --git a/docs/generators/javascript.md b/docs/generators/javascript.md index aa5f7aaaca60646299bcada2158373b68ae61502..38b07ad998495e42c3941480df03d61202e7b34a 100644 --- a/docs/generators/javascript.md +++ b/docs/generators/javascript.md @@ -44,6 +44,15 @@ These options may be applied as additional-properties (cli) or configOptions (pl |useInheritance|use JavaScript prototype chains & delegation for inheritance| |true| |usePromises|use Promises as return values from the client API, instead of superagent callbacks| |false| +## SUPPORTED VENDOR EXTENSIONS + +| Extension name | Description | Applicable for | Default value | +| -------------- | ----------- | -------------- | ------------- | +|x-all-of-name|Specify the name of the generated allOf composed schema|MODEL|null| +|x-one-of-name|Specify the name of the generated oneOf composed schema|MODEL|null| +|x-is-one-of-interface|Generate the oneOf composed schema as a marker interface|MODEL|null| + + ## IMPORT MAPPING | Type/Alias | Imports | diff --git a/docs/generators/jaxrs-cxf-cdi.md b/docs/generators/jaxrs-cxf-cdi.md index 037561df4e005ed513c1b1fc3b47b98121908170..dfe8da369339fd99eadbe6eea8251861d06c2a86 100644 --- a/docs/generators/jaxrs-cxf-cdi.md +++ b/docs/generators/jaxrs-cxf-cdi.md @@ -82,14 +82,17 @@ These options may be applied as additional-properties (cli) or configOptions (pl | Extension name | Description | Applicable for | Default value | | -------------- | ----------- | -------------- | ------------- | -|x-discriminator-value|Used with model inheritance to specify value for discriminator that identifies current model|MODEL| -|x-implements|Ability to specify interfaces that model must implements|MODEL|empty array -|x-setter-extra-annotation|Custom annotation that can be specified over java setter for specific field|FIELD|When field is array & uniqueItems, then this extension is used to add `@JsonDeserialize(as = LinkedHashSet.class)` over setter, otherwise no value -|x-tags|Specify multiple swagger tags for operation|OPERATION|null -|x-accepts|Specify custom value for 'Accept' header for operation|OPERATION|null -|x-content-type|Specify custom value for 'Content-Type' header for operation|OPERATION|null -|x-class-extra-annotation|List of custom annotations to be added to model|MODEL|null -|x-field-extra-annotation|List of custom annotations to be added to property|FIELD|null +|x-all-of-name|Specify the name of the generated allOf composed schema|MODEL|null| +|x-one-of-name|Specify the name of the generated oneOf composed schema|MODEL|null| +|x-is-one-of-interface|Generate the oneOf composed schema as a marker interface|MODEL|null| +|x-discriminator-value|Used with model inheritance to specify value for discriminator that identifies current model|MODEL|| +|x-implements|Ability to specify interfaces that model must implements|MODEL|empty array| +|x-setter-extra-annotation|Custom annotation that can be specified over java setter for specific field|FIELD|When field is array & uniqueItems, then this extension is used to add `@JsonDeserialize(as = LinkedHashSet.class)` over setter, otherwise no value| +|x-tags|Specify multiple swagger tags for operation|OPERATION|null| +|x-accepts|Specify custom value for 'Accept' header for operation|OPERATION|null| +|x-content-type|Specify custom value for 'Content-Type' header for operation|OPERATION|null| +|x-class-extra-annotation|List of custom annotations to be added to model|MODEL|null| +|x-field-extra-annotation|List of custom annotations to be added to property|FIELD|null| ## IMPORT MAPPING diff --git a/docs/generators/jaxrs-cxf-client.md b/docs/generators/jaxrs-cxf-client.md index 5a88f8efda7e019cb711d78c39700df8ee7b1d3f..8d0a57965b1d1f74689911c7b145a875f96ac234 100644 --- a/docs/generators/jaxrs-cxf-client.md +++ b/docs/generators/jaxrs-cxf-client.md @@ -73,14 +73,17 @@ These options may be applied as additional-properties (cli) or configOptions (pl | Extension name | Description | Applicable for | Default value | | -------------- | ----------- | -------------- | ------------- | -|x-discriminator-value|Used with model inheritance to specify value for discriminator that identifies current model|MODEL| -|x-implements|Ability to specify interfaces that model must implements|MODEL|empty array -|x-setter-extra-annotation|Custom annotation that can be specified over java setter for specific field|FIELD|When field is array & uniqueItems, then this extension is used to add `@JsonDeserialize(as = LinkedHashSet.class)` over setter, otherwise no value -|x-tags|Specify multiple swagger tags for operation|OPERATION|null -|x-accepts|Specify custom value for 'Accept' header for operation|OPERATION|null -|x-content-type|Specify custom value for 'Content-Type' header for operation|OPERATION|null -|x-class-extra-annotation|List of custom annotations to be added to model|MODEL|null -|x-field-extra-annotation|List of custom annotations to be added to property|FIELD|null +|x-all-of-name|Specify the name of the generated allOf composed schema|MODEL|null| +|x-one-of-name|Specify the name of the generated oneOf composed schema|MODEL|null| +|x-is-one-of-interface|Generate the oneOf composed schema as a marker interface|MODEL|null| +|x-discriminator-value|Used with model inheritance to specify value for discriminator that identifies current model|MODEL|| +|x-implements|Ability to specify interfaces that model must implements|MODEL|empty array| +|x-setter-extra-annotation|Custom annotation that can be specified over java setter for specific field|FIELD|When field is array & uniqueItems, then this extension is used to add `@JsonDeserialize(as = LinkedHashSet.class)` over setter, otherwise no value| +|x-tags|Specify multiple swagger tags for operation|OPERATION|null| +|x-accepts|Specify custom value for 'Accept' header for operation|OPERATION|null| +|x-content-type|Specify custom value for 'Content-Type' header for operation|OPERATION|null| +|x-class-extra-annotation|List of custom annotations to be added to model|MODEL|null| +|x-field-extra-annotation|List of custom annotations to be added to property|FIELD|null| ## IMPORT MAPPING diff --git a/docs/generators/jaxrs-cxf-extended.md b/docs/generators/jaxrs-cxf-extended.md index a82963291385ba3377ad313863f2221d0dbc056e..695c4e43bdf91207d03336d6ce0b099afff068ff 100644 --- a/docs/generators/jaxrs-cxf-extended.md +++ b/docs/generators/jaxrs-cxf-extended.md @@ -96,14 +96,17 @@ These options may be applied as additional-properties (cli) or configOptions (pl | Extension name | Description | Applicable for | Default value | | -------------- | ----------- | -------------- | ------------- | -|x-discriminator-value|Used with model inheritance to specify value for discriminator that identifies current model|MODEL| -|x-implements|Ability to specify interfaces that model must implements|MODEL|empty array -|x-setter-extra-annotation|Custom annotation that can be specified over java setter for specific field|FIELD|When field is array & uniqueItems, then this extension is used to add `@JsonDeserialize(as = LinkedHashSet.class)` over setter, otherwise no value -|x-tags|Specify multiple swagger tags for operation|OPERATION|null -|x-accepts|Specify custom value for 'Accept' header for operation|OPERATION|null -|x-content-type|Specify custom value for 'Content-Type' header for operation|OPERATION|null -|x-class-extra-annotation|List of custom annotations to be added to model|MODEL|null -|x-field-extra-annotation|List of custom annotations to be added to property|FIELD|null +|x-all-of-name|Specify the name of the generated allOf composed schema|MODEL|null| +|x-one-of-name|Specify the name of the generated oneOf composed schema|MODEL|null| +|x-is-one-of-interface|Generate the oneOf composed schema as a marker interface|MODEL|null| +|x-discriminator-value|Used with model inheritance to specify value for discriminator that identifies current model|MODEL|| +|x-implements|Ability to specify interfaces that model must implements|MODEL|empty array| +|x-setter-extra-annotation|Custom annotation that can be specified over java setter for specific field|FIELD|When field is array & uniqueItems, then this extension is used to add `@JsonDeserialize(as = LinkedHashSet.class)` over setter, otherwise no value| +|x-tags|Specify multiple swagger tags for operation|OPERATION|null| +|x-accepts|Specify custom value for 'Accept' header for operation|OPERATION|null| +|x-content-type|Specify custom value for 'Content-Type' header for operation|OPERATION|null| +|x-class-extra-annotation|List of custom annotations to be added to model|MODEL|null| +|x-field-extra-annotation|List of custom annotations to be added to property|FIELD|null| ## IMPORT MAPPING diff --git a/docs/generators/jaxrs-cxf.md b/docs/generators/jaxrs-cxf.md index 2e53fd1d121b5fbbdbccf4e84c30b2d5f788273e..7d96ef01c0ad4c160d0ae463c6ae91e2bce1ec20 100644 --- a/docs/generators/jaxrs-cxf.md +++ b/docs/generators/jaxrs-cxf.md @@ -91,14 +91,17 @@ These options may be applied as additional-properties (cli) or configOptions (pl | Extension name | Description | Applicable for | Default value | | -------------- | ----------- | -------------- | ------------- | -|x-discriminator-value|Used with model inheritance to specify value for discriminator that identifies current model|MODEL| -|x-implements|Ability to specify interfaces that model must implements|MODEL|empty array -|x-setter-extra-annotation|Custom annotation that can be specified over java setter for specific field|FIELD|When field is array & uniqueItems, then this extension is used to add `@JsonDeserialize(as = LinkedHashSet.class)` over setter, otherwise no value -|x-tags|Specify multiple swagger tags for operation|OPERATION|null -|x-accepts|Specify custom value for 'Accept' header for operation|OPERATION|null -|x-content-type|Specify custom value for 'Content-Type' header for operation|OPERATION|null -|x-class-extra-annotation|List of custom annotations to be added to model|MODEL|null -|x-field-extra-annotation|List of custom annotations to be added to property|FIELD|null +|x-all-of-name|Specify the name of the generated allOf composed schema|MODEL|null| +|x-one-of-name|Specify the name of the generated oneOf composed schema|MODEL|null| +|x-is-one-of-interface|Generate the oneOf composed schema as a marker interface|MODEL|null| +|x-discriminator-value|Used with model inheritance to specify value for discriminator that identifies current model|MODEL|| +|x-implements|Ability to specify interfaces that model must implements|MODEL|empty array| +|x-setter-extra-annotation|Custom annotation that can be specified over java setter for specific field|FIELD|When field is array & uniqueItems, then this extension is used to add `@JsonDeserialize(as = LinkedHashSet.class)` over setter, otherwise no value| +|x-tags|Specify multiple swagger tags for operation|OPERATION|null| +|x-accepts|Specify custom value for 'Accept' header for operation|OPERATION|null| +|x-content-type|Specify custom value for 'Content-Type' header for operation|OPERATION|null| +|x-class-extra-annotation|List of custom annotations to be added to model|MODEL|null| +|x-field-extra-annotation|List of custom annotations to be added to property|FIELD|null| ## IMPORT MAPPING diff --git a/docs/generators/jaxrs-jersey.md b/docs/generators/jaxrs-jersey.md index b557dda38af9e307b34dedda528284c4dc963179..28dd881356e244870f1e9b8c12d89e5f6cc292d7 100644 --- a/docs/generators/jaxrs-jersey.md +++ b/docs/generators/jaxrs-jersey.md @@ -76,14 +76,17 @@ These options may be applied as additional-properties (cli) or configOptions (pl | Extension name | Description | Applicable for | Default value | | -------------- | ----------- | -------------- | ------------- | -|x-discriminator-value|Used with model inheritance to specify value for discriminator that identifies current model|MODEL| -|x-implements|Ability to specify interfaces that model must implements|MODEL|empty array -|x-setter-extra-annotation|Custom annotation that can be specified over java setter for specific field|FIELD|When field is array & uniqueItems, then this extension is used to add `@JsonDeserialize(as = LinkedHashSet.class)` over setter, otherwise no value -|x-tags|Specify multiple swagger tags for operation|OPERATION|null -|x-accepts|Specify custom value for 'Accept' header for operation|OPERATION|null -|x-content-type|Specify custom value for 'Content-Type' header for operation|OPERATION|null -|x-class-extra-annotation|List of custom annotations to be added to model|MODEL|null -|x-field-extra-annotation|List of custom annotations to be added to property|FIELD|null +|x-all-of-name|Specify the name of the generated allOf composed schema|MODEL|null| +|x-one-of-name|Specify the name of the generated oneOf composed schema|MODEL|null| +|x-is-one-of-interface|Generate the oneOf composed schema as a marker interface|MODEL|null| +|x-discriminator-value|Used with model inheritance to specify value for discriminator that identifies current model|MODEL|| +|x-implements|Ability to specify interfaces that model must implements|MODEL|empty array| +|x-setter-extra-annotation|Custom annotation that can be specified over java setter for specific field|FIELD|When field is array & uniqueItems, then this extension is used to add `@JsonDeserialize(as = LinkedHashSet.class)` over setter, otherwise no value| +|x-tags|Specify multiple swagger tags for operation|OPERATION|null| +|x-accepts|Specify custom value for 'Accept' header for operation|OPERATION|null| +|x-content-type|Specify custom value for 'Content-Type' header for operation|OPERATION|null| +|x-class-extra-annotation|List of custom annotations to be added to model|MODEL|null| +|x-field-extra-annotation|List of custom annotations to be added to property|FIELD|null| ## IMPORT MAPPING diff --git a/docs/generators/jaxrs-resteasy-eap.md b/docs/generators/jaxrs-resteasy-eap.md index ba434fcf90a1973e4d02426371015b0cd6256c16..d4d99440a5cfca6d5402f6cc349e76c7b1c96c8b 100644 --- a/docs/generators/jaxrs-resteasy-eap.md +++ b/docs/generators/jaxrs-resteasy-eap.md @@ -76,14 +76,17 @@ These options may be applied as additional-properties (cli) or configOptions (pl | Extension name | Description | Applicable for | Default value | | -------------- | ----------- | -------------- | ------------- | -|x-discriminator-value|Used with model inheritance to specify value for discriminator that identifies current model|MODEL| -|x-implements|Ability to specify interfaces that model must implements|MODEL|empty array -|x-setter-extra-annotation|Custom annotation that can be specified over java setter for specific field|FIELD|When field is array & uniqueItems, then this extension is used to add `@JsonDeserialize(as = LinkedHashSet.class)` over setter, otherwise no value -|x-tags|Specify multiple swagger tags for operation|OPERATION|null -|x-accepts|Specify custom value for 'Accept' header for operation|OPERATION|null -|x-content-type|Specify custom value for 'Content-Type' header for operation|OPERATION|null -|x-class-extra-annotation|List of custom annotations to be added to model|MODEL|null -|x-field-extra-annotation|List of custom annotations to be added to property|FIELD|null +|x-all-of-name|Specify the name of the generated allOf composed schema|MODEL|null| +|x-one-of-name|Specify the name of the generated oneOf composed schema|MODEL|null| +|x-is-one-of-interface|Generate the oneOf composed schema as a marker interface|MODEL|null| +|x-discriminator-value|Used with model inheritance to specify value for discriminator that identifies current model|MODEL|| +|x-implements|Ability to specify interfaces that model must implements|MODEL|empty array| +|x-setter-extra-annotation|Custom annotation that can be specified over java setter for specific field|FIELD|When field is array & uniqueItems, then this extension is used to add `@JsonDeserialize(as = LinkedHashSet.class)` over setter, otherwise no value| +|x-tags|Specify multiple swagger tags for operation|OPERATION|null| +|x-accepts|Specify custom value for 'Accept' header for operation|OPERATION|null| +|x-content-type|Specify custom value for 'Content-Type' header for operation|OPERATION|null| +|x-class-extra-annotation|List of custom annotations to be added to model|MODEL|null| +|x-field-extra-annotation|List of custom annotations to be added to property|FIELD|null| ## IMPORT MAPPING diff --git a/docs/generators/jaxrs-resteasy.md b/docs/generators/jaxrs-resteasy.md index b7808f28eea6a1b927f9561ffa468869857a4d2e..75b77408a19266780dbe60016780cc79a6dd23ad 100644 --- a/docs/generators/jaxrs-resteasy.md +++ b/docs/generators/jaxrs-resteasy.md @@ -75,14 +75,17 @@ These options may be applied as additional-properties (cli) or configOptions (pl | Extension name | Description | Applicable for | Default value | | -------------- | ----------- | -------------- | ------------- | -|x-discriminator-value|Used with model inheritance to specify value for discriminator that identifies current model|MODEL| -|x-implements|Ability to specify interfaces that model must implements|MODEL|empty array -|x-setter-extra-annotation|Custom annotation that can be specified over java setter for specific field|FIELD|When field is array & uniqueItems, then this extension is used to add `@JsonDeserialize(as = LinkedHashSet.class)` over setter, otherwise no value -|x-tags|Specify multiple swagger tags for operation|OPERATION|null -|x-accepts|Specify custom value for 'Accept' header for operation|OPERATION|null -|x-content-type|Specify custom value for 'Content-Type' header for operation|OPERATION|null -|x-class-extra-annotation|List of custom annotations to be added to model|MODEL|null -|x-field-extra-annotation|List of custom annotations to be added to property|FIELD|null +|x-all-of-name|Specify the name of the generated allOf composed schema|MODEL|null| +|x-one-of-name|Specify the name of the generated oneOf composed schema|MODEL|null| +|x-is-one-of-interface|Generate the oneOf composed schema as a marker interface|MODEL|null| +|x-discriminator-value|Used with model inheritance to specify value for discriminator that identifies current model|MODEL|| +|x-implements|Ability to specify interfaces that model must implements|MODEL|empty array| +|x-setter-extra-annotation|Custom annotation that can be specified over java setter for specific field|FIELD|When field is array & uniqueItems, then this extension is used to add `@JsonDeserialize(as = LinkedHashSet.class)` over setter, otherwise no value| +|x-tags|Specify multiple swagger tags for operation|OPERATION|null| +|x-accepts|Specify custom value for 'Accept' header for operation|OPERATION|null| +|x-content-type|Specify custom value for 'Content-Type' header for operation|OPERATION|null| +|x-class-extra-annotation|List of custom annotations to be added to model|MODEL|null| +|x-field-extra-annotation|List of custom annotations to be added to property|FIELD|null| ## IMPORT MAPPING diff --git a/docs/generators/jaxrs-spec.md b/docs/generators/jaxrs-spec.md index b5fec0a0e6166d3f9984d3bba64c28dcedcc05d0..d95790d4e9b0707c039537b54f11ed8f289bedc1 100644 --- a/docs/generators/jaxrs-spec.md +++ b/docs/generators/jaxrs-spec.md @@ -82,14 +82,17 @@ These options may be applied as additional-properties (cli) or configOptions (pl | Extension name | Description | Applicable for | Default value | | -------------- | ----------- | -------------- | ------------- | -|x-discriminator-value|Used with model inheritance to specify value for discriminator that identifies current model|MODEL| -|x-implements|Ability to specify interfaces that model must implements|MODEL|empty array -|x-setter-extra-annotation|Custom annotation that can be specified over java setter for specific field|FIELD|When field is array & uniqueItems, then this extension is used to add `@JsonDeserialize(as = LinkedHashSet.class)` over setter, otherwise no value -|x-tags|Specify multiple swagger tags for operation|OPERATION|null -|x-accepts|Specify custom value for 'Accept' header for operation|OPERATION|null -|x-content-type|Specify custom value for 'Content-Type' header for operation|OPERATION|null -|x-class-extra-annotation|List of custom annotations to be added to model|MODEL|null -|x-field-extra-annotation|List of custom annotations to be added to property|FIELD|null +|x-all-of-name|Specify the name of the generated allOf composed schema|MODEL|null| +|x-one-of-name|Specify the name of the generated oneOf composed schema|MODEL|null| +|x-is-one-of-interface|Generate the oneOf composed schema as a marker interface|MODEL|null| +|x-discriminator-value|Used with model inheritance to specify value for discriminator that identifies current model|MODEL|| +|x-implements|Ability to specify interfaces that model must implements|MODEL|empty array| +|x-setter-extra-annotation|Custom annotation that can be specified over java setter for specific field|FIELD|When field is array & uniqueItems, then this extension is used to add `@JsonDeserialize(as = LinkedHashSet.class)` over setter, otherwise no value| +|x-tags|Specify multiple swagger tags for operation|OPERATION|null| +|x-accepts|Specify custom value for 'Accept' header for operation|OPERATION|null| +|x-content-type|Specify custom value for 'Content-Type' header for operation|OPERATION|null| +|x-class-extra-annotation|List of custom annotations to be added to model|MODEL|null| +|x-field-extra-annotation|List of custom annotations to be added to property|FIELD|null| ## IMPORT MAPPING diff --git a/docs/generators/jmeter.md b/docs/generators/jmeter.md index 83b447c973212ca8843344b537191ae817ee247d..57095d9b4615dd1b25be4377bee4dcfd9493868a 100644 --- a/docs/generators/jmeter.md +++ b/docs/generators/jmeter.md @@ -27,6 +27,15 @@ 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| +## SUPPORTED VENDOR EXTENSIONS + +| Extension name | Description | Applicable for | Default value | +| -------------- | ----------- | -------------- | ------------- | +|x-all-of-name|Specify the name of the generated allOf composed schema|MODEL|null| +|x-one-of-name|Specify the name of the generated oneOf composed schema|MODEL|null| +|x-is-one-of-interface|Generate the oneOf composed schema as a marker interface|MODEL|null| + + ## IMPORT MAPPING | Type/Alias | Imports | diff --git a/docs/generators/k6.md b/docs/generators/k6.md index 8cbeda61021b06671dc7b9ed096758d4ac92df27..99293837308a8e28153f4da0687d8ed4ba2dc2c6 100644 --- a/docs/generators/k6.md +++ b/docs/generators/k6.md @@ -27,6 +27,15 @@ 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| +## SUPPORTED VENDOR EXTENSIONS + +| Extension name | Description | Applicable for | Default value | +| -------------- | ----------- | -------------- | ------------- | +|x-all-of-name|Specify the name of the generated allOf composed schema|MODEL|null| +|x-one-of-name|Specify the name of the generated oneOf composed schema|MODEL|null| +|x-is-one-of-interface|Generate the oneOf composed schema as a marker interface|MODEL|null| + + ## IMPORT MAPPING | Type/Alias | Imports | diff --git a/docs/generators/kotlin-server.md b/docs/generators/kotlin-server.md index 09983e9b2f831d4cd095442a2c2c643f76d2013c..ba619b2edfcc965e5c4c147ab67556be5e4537a6 100644 --- a/docs/generators/kotlin-server.md +++ b/docs/generators/kotlin-server.md @@ -44,6 +44,15 @@ These options may be applied as additional-properties (cli) or configOptions (pl |useBeanValidation|Use BeanValidation API annotations. This option is currently supported only when using jaxrs-spec library.| |false| |useCoroutines|Whether to use the Coroutines. This option is currently supported only when using jaxrs-spec library.| |false| +## SUPPORTED VENDOR EXTENSIONS + +| Extension name | Description | Applicable for | Default value | +| -------------- | ----------- | -------------- | ------------- | +|x-all-of-name|Specify the name of the generated allOf composed schema|MODEL|null| +|x-one-of-name|Specify the name of the generated oneOf composed schema|MODEL|null| +|x-is-one-of-interface|Generate the oneOf composed schema as a marker interface|MODEL|null| + + ## IMPORT MAPPING | Type/Alias | Imports | diff --git a/docs/generators/kotlin-spring.md b/docs/generators/kotlin-spring.md index bff2a15e67332d953e376e9539db1ceb9e6e1802..37a408a21dbaa804462e7ae9de4d740ad78def3f 100644 --- a/docs/generators/kotlin-spring.md +++ b/docs/generators/kotlin-spring.md @@ -49,6 +49,15 @@ These options may be applied as additional-properties (cli) or configOptions (pl |useBeanValidation|Use BeanValidation API annotations to validate data types| |true| |useTags|Whether to use tags for creating interface and controller class names| |false| +## SUPPORTED VENDOR EXTENSIONS + +| Extension name | Description | Applicable for | Default value | +| -------------- | ----------- | -------------- | ------------- | +|x-all-of-name|Specify the name of the generated allOf composed schema|MODEL|null| +|x-one-of-name|Specify the name of the generated oneOf composed schema|MODEL|null| +|x-is-one-of-interface|Generate the oneOf composed schema as a marker interface|MODEL|null| + + ## IMPORT MAPPING | Type/Alias | Imports | diff --git a/docs/generators/kotlin-vertx.md b/docs/generators/kotlin-vertx.md index 82e4dde5d623abc6a9429c2894bdf5f26808e6d5..b7bec06d618306e8ff7b904229607f8261ae42df 100644 --- a/docs/generators/kotlin-vertx.md +++ b/docs/generators/kotlin-vertx.md @@ -32,6 +32,15 @@ These options may be applied as additional-properties (cli) or configOptions (pl |sortParamsByRequiredFlag|Sort method arguments to place required parameters before optional parameters.| |null| |sourceFolder|source folder for generated code| |src/main/kotlin| +## SUPPORTED VENDOR EXTENSIONS + +| Extension name | Description | Applicable for | Default value | +| -------------- | ----------- | -------------- | ------------- | +|x-all-of-name|Specify the name of the generated allOf composed schema|MODEL|null| +|x-one-of-name|Specify the name of the generated oneOf composed schema|MODEL|null| +|x-is-one-of-interface|Generate the oneOf composed schema as a marker interface|MODEL|null| + + ## IMPORT MAPPING | Type/Alias | Imports | diff --git a/docs/generators/kotlin.md b/docs/generators/kotlin.md index ac3cf6922dc86ae550f04aadff88c484d5048bc4..ad407ca204f0b182fdf7252152e7a86bd0ed61a0 100644 --- a/docs/generators/kotlin.md +++ b/docs/generators/kotlin.md @@ -44,6 +44,15 @@ These options may be applied as additional-properties (cli) or configOptions (pl |useRxJava2|Whether to use the RxJava2 adapter with the retrofit2 library. IMPORTANT: this option has been deprecated. Please use `useRxJava3` instead.| |false| |useRxJava3|Whether to use the RxJava3 adapter with the retrofit2 library.| |false| +## SUPPORTED VENDOR EXTENSIONS + +| Extension name | Description | Applicable for | Default value | +| -------------- | ----------- | -------------- | ------------- | +|x-all-of-name|Specify the name of the generated allOf composed schema|MODEL|null| +|x-one-of-name|Specify the name of the generated oneOf composed schema|MODEL|null| +|x-is-one-of-interface|Generate the oneOf composed schema as a marker interface|MODEL|null| + + ## IMPORT MAPPING | Type/Alias | Imports | diff --git a/docs/generators/ktorm-schema.md b/docs/generators/ktorm-schema.md index a72e9887a988b03ea66b913d8a008186bf8f39ee..82f7e9d77c340f4cb2dfac52e312fd9abdda0e94 100644 --- a/docs/generators/ktorm-schema.md +++ b/docs/generators/ktorm-schema.md @@ -33,6 +33,15 @@ These options may be applied as additional-properties (cli) or configOptions (pl |sortParamsByRequiredFlag|Sort method arguments to place required parameters before optional parameters.| |null| |sourceFolder|source folder for generated code| |src/main/kotlin| +## SUPPORTED VENDOR EXTENSIONS + +| Extension name | Description | Applicable for | Default value | +| -------------- | ----------- | -------------- | ------------- | +|x-all-of-name|Specify the name of the generated allOf composed schema|MODEL|null| +|x-one-of-name|Specify the name of the generated oneOf composed schema|MODEL|null| +|x-is-one-of-interface|Generate the oneOf composed schema as a marker interface|MODEL|null| + + ## IMPORT MAPPING | Type/Alias | Imports | diff --git a/docs/generators/lua.md b/docs/generators/lua.md index cf2ece49ed11dc0729cea009f916cce036095c55..1ff799ed0e170274c3e1b5824303deefded1070a 100644 --- a/docs/generators/lua.md +++ b/docs/generators/lua.md @@ -22,6 +22,15 @@ These options may be applied as additional-properties (cli) or configOptions (pl |packageName|Lua package name (convention: single word).| |openapiclient| |packageVersion|Lua package version.| |1.0.0-1| +## SUPPORTED VENDOR EXTENSIONS + +| Extension name | Description | Applicable for | Default value | +| -------------- | ----------- | -------------- | ------------- | +|x-all-of-name|Specify the name of the generated allOf composed schema|MODEL|null| +|x-one-of-name|Specify the name of the generated oneOf composed schema|MODEL|null| +|x-is-one-of-interface|Generate the oneOf composed schema as a marker interface|MODEL|null| + + ## IMPORT MAPPING | Type/Alias | Imports | diff --git a/docs/generators/markdown.md b/docs/generators/markdown.md index c930ef6fd68b55f02bae830ea0eed561d8a4aa12..8498cd73aa5a29f8c7d6ec7da1187f87ee6cf2ff 100644 --- a/docs/generators/markdown.md +++ b/docs/generators/markdown.md @@ -26,6 +26,15 @@ 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| +## SUPPORTED VENDOR EXTENSIONS + +| Extension name | Description | Applicable for | Default value | +| -------------- | ----------- | -------------- | ------------- | +|x-all-of-name|Specify the name of the generated allOf composed schema|MODEL|null| +|x-one-of-name|Specify the name of the generated oneOf composed schema|MODEL|null| +|x-is-one-of-interface|Generate the oneOf composed schema as a marker interface|MODEL|null| + + ## IMPORT MAPPING | Type/Alias | Imports | diff --git a/docs/generators/mysql-schema.md b/docs/generators/mysql-schema.md index 656452b91a69c3b6450a4c13c0c93afe00ee8e28..207623540cafb8adc7853a2ca1109e3b0938430c 100644 --- a/docs/generators/mysql-schema.md +++ b/docs/generators/mysql-schema.md @@ -23,6 +23,15 @@ These options may be applied as additional-properties (cli) or configOptions (pl |jsonDataTypeEnabled|Use special JSON MySQL data type for complex model properties. Requires MySQL version 5.7.8. Generates TEXT data type when disabled| |true| |namedParametersEnabled|Generates model prepared SQLs with named parameters, eg. :petName. Question mark placeholder used when option disabled.| |false| +## SUPPORTED VENDOR EXTENSIONS + +| Extension name | Description | Applicable for | Default value | +| -------------- | ----------- | -------------- | ------------- | +|x-all-of-name|Specify the name of the generated allOf composed schema|MODEL|null| +|x-one-of-name|Specify the name of the generated oneOf composed schema|MODEL|null| +|x-is-one-of-interface|Generate the oneOf composed schema as a marker interface|MODEL|null| + + ## IMPORT MAPPING | Type/Alias | Imports | diff --git a/docs/generators/nim.md b/docs/generators/nim.md index 2cf0c86e25a645910d5ca77110c50dbe767152ad..cda6e805d20f0873b52d31e1bab5756ae189edef 100644 --- a/docs/generators/nim.md +++ b/docs/generators/nim.md @@ -27,6 +27,15 @@ 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| +## SUPPORTED VENDOR EXTENSIONS + +| Extension name | Description | Applicable for | Default value | +| -------------- | ----------- | -------------- | ------------- | +|x-all-of-name|Specify the name of the generated allOf composed schema|MODEL|null| +|x-one-of-name|Specify the name of the generated oneOf composed schema|MODEL|null| +|x-is-one-of-interface|Generate the oneOf composed schema as a marker interface|MODEL|null| + + ## IMPORT MAPPING | Type/Alias | Imports | diff --git a/docs/generators/nodejs-express-server.md b/docs/generators/nodejs-express-server.md index ec3e45fa4eeb281de6da582847e80bbf4e9b0296..9b6c8d263929bb4b47971a308c8b81d3e250c4e1 100644 --- a/docs/generators/nodejs-express-server.md +++ b/docs/generators/nodejs-express-server.md @@ -28,6 +28,15 @@ 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| +## SUPPORTED VENDOR EXTENSIONS + +| Extension name | Description | Applicable for | Default value | +| -------------- | ----------- | -------------- | ------------- | +|x-all-of-name|Specify the name of the generated allOf composed schema|MODEL|null| +|x-one-of-name|Specify the name of the generated oneOf composed schema|MODEL|null| +|x-is-one-of-interface|Generate the oneOf composed schema as a marker interface|MODEL|null| + + ## IMPORT MAPPING | Type/Alias | Imports | diff --git a/docs/generators/objc.md b/docs/generators/objc.md index b76a06f29a362af6c5ee0410521f03731671809a..4ab6c925dffbfb5fa695c6db9feb74cc62d84511 100644 --- a/docs/generators/objc.md +++ b/docs/generators/objc.md @@ -27,6 +27,15 @@ These options may be applied as additional-properties (cli) or configOptions (pl |podName|cocoapods package name (convention: CameCase).| |OpenAPIClient| |podVersion|cocoapods package version.| |1.0.0| +## SUPPORTED VENDOR EXTENSIONS + +| Extension name | Description | Applicable for | Default value | +| -------------- | ----------- | -------------- | ------------- | +|x-all-of-name|Specify the name of the generated allOf composed schema|MODEL|null| +|x-one-of-name|Specify the name of the generated oneOf composed schema|MODEL|null| +|x-is-one-of-interface|Generate the oneOf composed schema as a marker interface|MODEL|null| + + ## IMPORT MAPPING | Type/Alias | Imports | diff --git a/docs/generators/ocaml.md b/docs/generators/ocaml.md index fec524c3f16ea542cb7826103dd9a889fdee6251..8899ccad9ccc0bf83e708ea18d89c3a3d209b7e6 100644 --- a/docs/generators/ocaml.md +++ b/docs/generators/ocaml.md @@ -27,6 +27,15 @@ 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| +## SUPPORTED VENDOR EXTENSIONS + +| Extension name | Description | Applicable for | Default value | +| -------------- | ----------- | -------------- | ------------- | +|x-all-of-name|Specify the name of the generated allOf composed schema|MODEL|null| +|x-one-of-name|Specify the name of the generated oneOf composed schema|MODEL|null| +|x-is-one-of-interface|Generate the oneOf composed schema as a marker interface|MODEL|null| + + ## IMPORT MAPPING | Type/Alias | Imports | diff --git a/docs/generators/openapi-yaml.md b/docs/generators/openapi-yaml.md index 854f487d3434ef0f375d62d58a8f3ba11bd59d68..a5fbf8f7519d4eae6530672c4efc0bf3070e8a32 100644 --- a/docs/generators/openapi-yaml.md +++ b/docs/generators/openapi-yaml.md @@ -27,6 +27,15 @@ 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| +## SUPPORTED VENDOR EXTENSIONS + +| Extension name | Description | Applicable for | Default value | +| -------------- | ----------- | -------------- | ------------- | +|x-all-of-name|Specify the name of the generated allOf composed schema|MODEL|null| +|x-one-of-name|Specify the name of the generated oneOf composed schema|MODEL|null| +|x-is-one-of-interface|Generate the oneOf composed schema as a marker interface|MODEL|null| + + ## IMPORT MAPPING | Type/Alias | Imports | diff --git a/docs/generators/openapi.md b/docs/generators/openapi.md index 75573383de472d4628538defe52a2d5089ed3515..68fcdde8c1f7bf1a4d6ab4c86e92321bfda49e52 100644 --- a/docs/generators/openapi.md +++ b/docs/generators/openapi.md @@ -27,6 +27,15 @@ 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| +## SUPPORTED VENDOR EXTENSIONS + +| Extension name | Description | Applicable for | Default value | +| -------------- | ----------- | -------------- | ------------- | +|x-all-of-name|Specify the name of the generated allOf composed schema|MODEL|null| +|x-one-of-name|Specify the name of the generated oneOf composed schema|MODEL|null| +|x-is-one-of-interface|Generate the oneOf composed schema as a marker interface|MODEL|null| + + ## IMPORT MAPPING | Type/Alias | Imports | diff --git a/docs/generators/perl.md b/docs/generators/perl.md index 9fd91025c364c09f9ea3d1b396f02d7fdcfc2999..664df4c5e75fcc6da5c70baaa1c1249d0da35d39 100644 --- a/docs/generators/perl.md +++ b/docs/generators/perl.md @@ -25,6 +25,15 @@ These options may be applied as additional-properties (cli) or configOptions (pl |prependFormOrBodyParameters|Add form or body parameters to the beginning of the parameter list.| |false| |sortParamsByRequiredFlag|Sort method arguments to place required parameters before optional parameters.| |true| +## SUPPORTED VENDOR EXTENSIONS + +| Extension name | Description | Applicable for | Default value | +| -------------- | ----------- | -------------- | ------------- | +|x-all-of-name|Specify the name of the generated allOf composed schema|MODEL|null| +|x-one-of-name|Specify the name of the generated oneOf composed schema|MODEL|null| +|x-is-one-of-interface|Generate the oneOf composed schema as a marker interface|MODEL|null| + + ## IMPORT MAPPING | Type/Alias | Imports | diff --git a/docs/generators/php-dt.md b/docs/generators/php-dt.md index ad004234dcc804646423bdb67ea170f2c95cfaba..423c3b153a2a781d46bcc68a92c889126402a88c 100644 --- a/docs/generators/php-dt.md +++ b/docs/generators/php-dt.md @@ -35,6 +35,15 @@ These options may be applied as additional-properties (cli) or configOptions (pl |srcBasePath|The directory to serve as source root.| |null| |variableNamingConvention|naming convention of variable name, e.g. camelCase.| |snake_case| +## SUPPORTED VENDOR EXTENSIONS + +| Extension name | Description | Applicable for | Default value | +| -------------- | ----------- | -------------- | ------------- | +|x-all-of-name|Specify the name of the generated allOf composed schema|MODEL|null| +|x-one-of-name|Specify the name of the generated oneOf composed schema|MODEL|null| +|x-is-one-of-interface|Generate the oneOf composed schema as a marker interface|MODEL|null| + + ## IMPORT MAPPING | Type/Alias | Imports | diff --git a/docs/generators/php-laravel.md b/docs/generators/php-laravel.md index bdce19bad5e39e2a2668d82c1cb8abad9edab0a9..3a8b3e7ec45c480af175116cb1801e8a85d4423e 100644 --- a/docs/generators/php-laravel.md +++ b/docs/generators/php-laravel.md @@ -34,6 +34,15 @@ These options may be applied as additional-properties (cli) or configOptions (pl |srcBasePath|The directory to serve as source root.| |null| |variableNamingConvention|naming convention of variable name, e.g. camelCase.| |snake_case| +## SUPPORTED VENDOR EXTENSIONS + +| Extension name | Description | Applicable for | Default value | +| -------------- | ----------- | -------------- | ------------- | +|x-all-of-name|Specify the name of the generated allOf composed schema|MODEL|null| +|x-one-of-name|Specify the name of the generated oneOf composed schema|MODEL|null| +|x-is-one-of-interface|Generate the oneOf composed schema as a marker interface|MODEL|null| + + ## IMPORT MAPPING | Type/Alias | Imports | diff --git a/docs/generators/php-lumen.md b/docs/generators/php-lumen.md index ad7f5afc0612add40b7587573663e0ff27c1ba47..fa0f14588565961ac2a7d37598cf9c4653163109 100644 --- a/docs/generators/php-lumen.md +++ b/docs/generators/php-lumen.md @@ -34,6 +34,15 @@ These options may be applied as additional-properties (cli) or configOptions (pl |srcBasePath|The directory to serve as source root.| |null| |variableNamingConvention|naming convention of variable name, e.g. camelCase.| |snake_case| +## SUPPORTED VENDOR EXTENSIONS + +| Extension name | Description | Applicable for | Default value | +| -------------- | ----------- | -------------- | ------------- | +|x-all-of-name|Specify the name of the generated allOf composed schema|MODEL|null| +|x-one-of-name|Specify the name of the generated oneOf composed schema|MODEL|null| +|x-is-one-of-interface|Generate the oneOf composed schema as a marker interface|MODEL|null| + + ## IMPORT MAPPING | Type/Alias | Imports | diff --git a/docs/generators/php-mezzio-ph.md b/docs/generators/php-mezzio-ph.md index 18854d244ef2a8d31d48f0477b7baa624064f4ab..06433f3339a2919e0ae2572dfe16a303b2bf5015 100644 --- a/docs/generators/php-mezzio-ph.md +++ b/docs/generators/php-mezzio-ph.md @@ -35,6 +35,15 @@ These options may be applied as additional-properties (cli) or configOptions (pl |srcBasePath|The directory to serve as source root.| |null| |variableNamingConvention|naming convention of variable name, e.g. camelCase.| |snake_case| +## SUPPORTED VENDOR EXTENSIONS + +| Extension name | Description | Applicable for | Default value | +| -------------- | ----------- | -------------- | ------------- | +|x-all-of-name|Specify the name of the generated allOf composed schema|MODEL|null| +|x-one-of-name|Specify the name of the generated oneOf composed schema|MODEL|null| +|x-is-one-of-interface|Generate the oneOf composed schema as a marker interface|MODEL|null| + + ## IMPORT MAPPING | Type/Alias | Imports | diff --git a/docs/generators/php-slim-deprecated.md b/docs/generators/php-slim-deprecated.md index 4163fda38ef2866aa5e47fb8b7887076698a90ba..70751cf48334d8db3396223c5c3d2430b5cbb08a 100644 --- a/docs/generators/php-slim-deprecated.md +++ b/docs/generators/php-slim-deprecated.md @@ -34,6 +34,15 @@ These options may be applied as additional-properties (cli) or configOptions (pl |srcBasePath|The directory to serve as source root.| |null| |variableNamingConvention|naming convention of variable name, e.g. camelCase.| |camelCase| +## SUPPORTED VENDOR EXTENSIONS + +| Extension name | Description | Applicable for | Default value | +| -------------- | ----------- | -------------- | ------------- | +|x-all-of-name|Specify the name of the generated allOf composed schema|MODEL|null| +|x-one-of-name|Specify the name of the generated oneOf composed schema|MODEL|null| +|x-is-one-of-interface|Generate the oneOf composed schema as a marker interface|MODEL|null| + + ## IMPORT MAPPING | Type/Alias | Imports | diff --git a/docs/generators/php-slim4.md b/docs/generators/php-slim4.md index 0c56d968d14dcad1c1f56ec8f2b98b0e104ce5de..f778bf077bbc37faac9bc25336afae5616222d22 100644 --- a/docs/generators/php-slim4.md +++ b/docs/generators/php-slim4.md @@ -35,6 +35,15 @@ These options may be applied as additional-properties (cli) or configOptions (pl |srcBasePath|The directory to serve as source root.| |null| |variableNamingConvention|naming convention of variable name, e.g. camelCase.| |camelCase| +## SUPPORTED VENDOR EXTENSIONS + +| Extension name | Description | Applicable for | Default value | +| -------------- | ----------- | -------------- | ------------- | +|x-all-of-name|Specify the name of the generated allOf composed schema|MODEL|null| +|x-one-of-name|Specify the name of the generated oneOf composed schema|MODEL|null| +|x-is-one-of-interface|Generate the oneOf composed schema as a marker interface|MODEL|null| + + ## IMPORT MAPPING | Type/Alias | Imports | diff --git a/docs/generators/php-symfony.md b/docs/generators/php-symfony.md index e602a0570af18445073b440cf2372aa7566dcc32..3892b7bb299e091b826c7cb41b36605c624f32ff 100644 --- a/docs/generators/php-symfony.md +++ b/docs/generators/php-symfony.md @@ -40,6 +40,15 @@ These options may be applied as additional-properties (cli) or configOptions (pl |srcBasePath|The directory to serve as source root.| |null| |variableNamingConvention|naming convention of variable name, e.g. camelCase.| |snake_case| +## SUPPORTED VENDOR EXTENSIONS + +| Extension name | Description | Applicable for | Default value | +| -------------- | ----------- | -------------- | ------------- | +|x-all-of-name|Specify the name of the generated allOf composed schema|MODEL|null| +|x-one-of-name|Specify the name of the generated oneOf composed schema|MODEL|null| +|x-is-one-of-interface|Generate the oneOf composed schema as a marker interface|MODEL|null| + + ## IMPORT MAPPING | Type/Alias | Imports | diff --git a/docs/generators/php.md b/docs/generators/php.md index f7a74f48c6aeacd43b24f9a604be743936d26656..9084f6d19ee1a56db91127efc0c02464d54e9189 100644 --- a/docs/generators/php.md +++ b/docs/generators/php.md @@ -35,6 +35,15 @@ These options may be applied as additional-properties (cli) or configOptions (pl |srcBasePath|The directory to serve as source root.| |null| |variableNamingConvention|naming convention of variable name, e.g. camelCase.| |snake_case| +## SUPPORTED VENDOR EXTENSIONS + +| Extension name | Description | Applicable for | Default value | +| -------------- | ----------- | -------------- | ------------- | +|x-all-of-name|Specify the name of the generated allOf composed schema|MODEL|null| +|x-one-of-name|Specify the name of the generated oneOf composed schema|MODEL|null| +|x-is-one-of-interface|Generate the oneOf composed schema as a marker interface|MODEL|null| + + ## IMPORT MAPPING | Type/Alias | Imports | diff --git a/docs/generators/plantuml.md b/docs/generators/plantuml.md index 033b995b72bd6c9792455237506e85bf97d2243c..0d9237a0801bfac75464c40c4abf55d9742452be 100644 --- a/docs/generators/plantuml.md +++ b/docs/generators/plantuml.md @@ -26,6 +26,15 @@ 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| +## SUPPORTED VENDOR EXTENSIONS + +| Extension name | Description | Applicable for | Default value | +| -------------- | ----------- | -------------- | ------------- | +|x-all-of-name|Specify the name of the generated allOf composed schema|MODEL|null| +|x-one-of-name|Specify the name of the generated oneOf composed schema|MODEL|null| +|x-is-one-of-interface|Generate the oneOf composed schema as a marker interface|MODEL|null| + + ## IMPORT MAPPING | Type/Alias | Imports | diff --git a/docs/generators/powershell.md b/docs/generators/powershell.md index f35ad8599ac6806040ad89eb08f14243d19b6390..1c5d2a9bc02a4f97363c8129f16dfa4c071d3871 100644 --- a/docs/generators/powershell.md +++ b/docs/generators/powershell.md @@ -36,6 +36,15 @@ These options may be applied as additional-properties (cli) or configOptions (pl |useClassNameInModelsExamples|Use classname instead of name when generating the Models cmdlets in the examples.| |true| |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.| |null| +## SUPPORTED VENDOR EXTENSIONS + +| Extension name | Description | Applicable for | Default value | +| -------------- | ----------- | -------------- | ------------- | +|x-all-of-name|Specify the name of the generated allOf composed schema|MODEL|null| +|x-one-of-name|Specify the name of the generated oneOf composed schema|MODEL|null| +|x-is-one-of-interface|Generate the oneOf composed schema as a marker interface|MODEL|null| + + ## IMPORT MAPPING | Type/Alias | Imports | diff --git a/docs/generators/protobuf-schema.md b/docs/generators/protobuf-schema.md index eb8d398cba939a315f5f37157edf1799cbce8560..cb334281b7f5ba62eae36f33fb79326aaa23006e 100644 --- a/docs/generators/protobuf-schema.md +++ b/docs/generators/protobuf-schema.md @@ -21,6 +21,15 @@ These options may be applied as additional-properties (cli) or configOptions (pl |numberedFieldNumberList|Field numbers in order.| |false| |startEnumsWithUnknown|Introduces "UNKNOWN" as the first element of enumerations.| |false| +## SUPPORTED VENDOR EXTENSIONS + +| Extension name | Description | Applicable for | Default value | +| -------------- | ----------- | -------------- | ------------- | +|x-all-of-name|Specify the name of the generated allOf composed schema|MODEL|null| +|x-one-of-name|Specify the name of the generated oneOf composed schema|MODEL|null| +|x-is-one-of-interface|Generate the oneOf composed schema as a marker interface|MODEL|null| + + ## IMPORT MAPPING | Type/Alias | Imports | diff --git a/docs/generators/python-aiohttp.md b/docs/generators/python-aiohttp.md index 0fea01b13bd5dffb3da25f5a090a7261fa25bd7f..03b35ae835131c502533cbb1adc28053c2c4a3e0 100644 --- a/docs/generators/python-aiohttp.md +++ b/docs/generators/python-aiohttp.md @@ -39,6 +39,15 @@ These options may be applied as additional-properties (cli) or configOptions (pl |useNose|use the nose test framework| |false| |usePythonSrcRootInImports|include pythonSrcRoot in import namespaces.| |false| +## SUPPORTED VENDOR EXTENSIONS + +| Extension name | Description | Applicable for | Default value | +| -------------- | ----------- | -------------- | ------------- | +|x-all-of-name|Specify the name of the generated allOf composed schema|MODEL|null| +|x-one-of-name|Specify the name of the generated oneOf composed schema|MODEL|null| +|x-is-one-of-interface|Generate the oneOf composed schema as a marker interface|MODEL|null| + + ## IMPORT MAPPING | Type/Alias | Imports | diff --git a/docs/generators/python-blueplanet.md b/docs/generators/python-blueplanet.md index 2445094ea2f67fc79d980ebba5e2e41bce838b08..5a57c9b183415206058451694762cd9bff5b9348 100644 --- a/docs/generators/python-blueplanet.md +++ b/docs/generators/python-blueplanet.md @@ -39,6 +39,15 @@ These options may be applied as additional-properties (cli) or configOptions (pl |useNose|use the nose test framework| |false| |usePythonSrcRootInImports|include pythonSrcRoot in import namespaces.| |false| +## SUPPORTED VENDOR EXTENSIONS + +| Extension name | Description | Applicable for | Default value | +| -------------- | ----------- | -------------- | ------------- | +|x-all-of-name|Specify the name of the generated allOf composed schema|MODEL|null| +|x-one-of-name|Specify the name of the generated oneOf composed schema|MODEL|null| +|x-is-one-of-interface|Generate the oneOf composed schema as a marker interface|MODEL|null| + + ## IMPORT MAPPING | Type/Alias | Imports | diff --git a/docs/generators/python-experimental.md b/docs/generators/python-experimental.md index 116f0399fa9d2eaaea3bf6e3670727dc6a927626..1d1c3ce2b495c9d3de0f7f40df304fe83633b446 100644 --- a/docs/generators/python-experimental.md +++ b/docs/generators/python-experimental.md @@ -29,6 +29,15 @@ These options may be applied as additional-properties (cli) or configOptions (pl |recursionLimit|Set the recursion limit. If not set, use the system default value.| |null| |useNose|use the nose test framework| |false| +## SUPPORTED VENDOR EXTENSIONS + +| Extension name | Description | Applicable for | Default value | +| -------------- | ----------- | -------------- | ------------- | +|x-all-of-name|Specify the name of the generated allOf composed schema|MODEL|null| +|x-one-of-name|Specify the name of the generated oneOf composed schema|MODEL|null| +|x-is-one-of-interface|Generate the oneOf composed schema as a marker interface|MODEL|null| + + ## IMPORT MAPPING | Type/Alias | Imports | diff --git a/docs/generators/python-fastapi.md b/docs/generators/python-fastapi.md index 163a85e50410fdf316b7057aaa0f678742a20c32..7f86d40a584733c923cddf424b0f0b99dee323e9 100644 --- a/docs/generators/python-fastapi.md +++ b/docs/generators/python-fastapi.md @@ -31,6 +31,15 @@ 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| +## SUPPORTED VENDOR EXTENSIONS + +| Extension name | Description | Applicable for | Default value | +| -------------- | ----------- | -------------- | ------------- | +|x-all-of-name|Specify the name of the generated allOf composed schema|MODEL|null| +|x-one-of-name|Specify the name of the generated oneOf composed schema|MODEL|null| +|x-is-one-of-interface|Generate the oneOf composed schema as a marker interface|MODEL|null| + + ## IMPORT MAPPING | Type/Alias | Imports | diff --git a/docs/generators/python-flask.md b/docs/generators/python-flask.md index 8cf4ec6e7a9d537d0ef8d57f8c39da5266693d99..936399e88482aec5f55af472ec93bf92c5f23378 100644 --- a/docs/generators/python-flask.md +++ b/docs/generators/python-flask.md @@ -39,6 +39,15 @@ These options may be applied as additional-properties (cli) or configOptions (pl |useNose|use the nose test framework| |false| |usePythonSrcRootInImports|include pythonSrcRoot in import namespaces.| |false| +## SUPPORTED VENDOR EXTENSIONS + +| Extension name | Description | Applicable for | Default value | +| -------------- | ----------- | -------------- | ------------- | +|x-all-of-name|Specify the name of the generated allOf composed schema|MODEL|null| +|x-one-of-name|Specify the name of the generated oneOf composed schema|MODEL|null| +|x-is-one-of-interface|Generate the oneOf composed schema as a marker interface|MODEL|null| + + ## IMPORT MAPPING | Type/Alias | Imports | diff --git a/docs/generators/python-legacy.md b/docs/generators/python-legacy.md index 08c0c42c0024a1b3adbbf68fa5a3fec56f9afe9d..f7865865275ff52fd3a79a8962d78bf285efc0eb 100644 --- a/docs/generators/python-legacy.md +++ b/docs/generators/python-legacy.md @@ -30,6 +30,15 @@ These options may be applied as additional-properties (cli) or configOptions (pl |sortParamsByRequiredFlag|Sort method arguments to place required parameters before optional parameters.| |true| |useNose|use the nose test framework| |false| +## SUPPORTED VENDOR EXTENSIONS + +| Extension name | Description | Applicable for | Default value | +| -------------- | ----------- | -------------- | ------------- | +|x-all-of-name|Specify the name of the generated allOf composed schema|MODEL|null| +|x-one-of-name|Specify the name of the generated oneOf composed schema|MODEL|null| +|x-is-one-of-interface|Generate the oneOf composed schema as a marker interface|MODEL|null| + + ## IMPORT MAPPING | Type/Alias | Imports | diff --git a/docs/generators/python.md b/docs/generators/python.md index 9b7e75b39deab8cff9d2f9ab5e738977f225134f..475f11410e3c8978524d64c77f977fdec229c97e 100644 --- a/docs/generators/python.md +++ b/docs/generators/python.md @@ -32,6 +32,15 @@ These options may be applied as additional-properties (cli) or configOptions (pl |recursionLimit|Set the recursion limit. If not set, use the system default value.| |null| |useNose|use the nose test framework| |false| +## SUPPORTED VENDOR EXTENSIONS + +| Extension name | Description | Applicable for | Default value | +| -------------- | ----------- | -------------- | ------------- | +|x-all-of-name|Specify the name of the generated allOf composed schema|MODEL|null| +|x-one-of-name|Specify the name of the generated oneOf composed schema|MODEL|null| +|x-is-one-of-interface|Generate the oneOf composed schema as a marker interface|MODEL|null| + + ## IMPORT MAPPING | Type/Alias | Imports | diff --git a/docs/generators/r.md b/docs/generators/r.md index d034e8620787c1ca967212152f961b115862e7d4..49cbc5ad8ce341566525f98532a100e9be0421f7 100644 --- a/docs/generators/r.md +++ b/docs/generators/r.md @@ -24,6 +24,15 @@ These options may be applied as additional-properties (cli) or configOptions (pl |packageVersion|R package version.| |1.0.0| |returnExceptionOnFailure|Throw an exception on non success response codes| |false| +## SUPPORTED VENDOR EXTENSIONS + +| Extension name | Description | Applicable for | Default value | +| -------------- | ----------- | -------------- | ------------- | +|x-all-of-name|Specify the name of the generated allOf composed schema|MODEL|null| +|x-one-of-name|Specify the name of the generated oneOf composed schema|MODEL|null| +|x-is-one-of-interface|Generate the oneOf composed schema as a marker interface|MODEL|null| + + ## IMPORT MAPPING | Type/Alias | Imports | diff --git a/docs/generators/ruby-on-rails.md b/docs/generators/ruby-on-rails.md index ecb8a858a81abad32be7835b552ada2a65e661d5..37a5768d6080bda48d77d331e815043957bbcb83 100644 --- a/docs/generators/ruby-on-rails.md +++ b/docs/generators/ruby-on-rails.md @@ -20,6 +20,15 @@ These options may be applied as additional-properties (cli) or configOptions (pl | ------ | ----------- | ------ | ------- | |databaseAdapter|The adapter for database (e.g. mysql, sqlite). Default: sqlite| |sqlite| +## SUPPORTED VENDOR EXTENSIONS + +| Extension name | Description | Applicable for | Default value | +| -------------- | ----------- | -------------- | ------------- | +|x-all-of-name|Specify the name of the generated allOf composed schema|MODEL|null| +|x-one-of-name|Specify the name of the generated oneOf composed schema|MODEL|null| +|x-is-one-of-interface|Generate the oneOf composed schema as a marker interface|MODEL|null| + + ## IMPORT MAPPING | Type/Alias | Imports | diff --git a/docs/generators/ruby-sinatra.md b/docs/generators/ruby-sinatra.md index a9655ea8e53698cfb8f22db5338099e7281e3a28..a2fc275b0061bf8296afeac3a03a7e0e5c7ce8e5 100644 --- a/docs/generators/ruby-sinatra.md +++ b/docs/generators/ruby-sinatra.md @@ -19,6 +19,15 @@ These options may be applied as additional-properties (cli) or configOptions (pl | Option | Description | Values | Default | | ------ | ----------- | ------ | ------- | +## SUPPORTED VENDOR EXTENSIONS + +| Extension name | Description | Applicable for | Default value | +| -------------- | ----------- | -------------- | ------------- | +|x-all-of-name|Specify the name of the generated allOf composed schema|MODEL|null| +|x-one-of-name|Specify the name of the generated oneOf composed schema|MODEL|null| +|x-is-one-of-interface|Generate the oneOf composed schema as a marker interface|MODEL|null| + + ## IMPORT MAPPING | Type/Alias | Imports | diff --git a/docs/generators/ruby.md b/docs/generators/ruby.md index f0188be575fa6a4c2589f3d2cb915085b4036f13..948472a82e5148bfda1148d3721c315c838119c3 100644 --- a/docs/generators/ruby.md +++ b/docs/generators/ruby.md @@ -39,6 +39,15 @@ 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| +## SUPPORTED VENDOR EXTENSIONS + +| Extension name | Description | Applicable for | Default value | +| -------------- | ----------- | -------------- | ------------- | +|x-all-of-name|Specify the name of the generated allOf composed schema|MODEL|null| +|x-one-of-name|Specify the name of the generated oneOf composed schema|MODEL|null| +|x-is-one-of-interface|Generate the oneOf composed schema as a marker interface|MODEL|null| + + ## IMPORT MAPPING | Type/Alias | Imports | diff --git a/docs/generators/rust-server.md b/docs/generators/rust-server.md index 52f2b52909d18b0557a0157d7682539b0e3ec6e9..1d800d0a7a648fea13d11941e3310121caff3ba2 100644 --- a/docs/generators/rust-server.md +++ b/docs/generators/rust-server.md @@ -21,6 +21,15 @@ These options may be applied as additional-properties (cli) or configOptions (pl |packageName|Rust crate name (convention: snake_case).| |openapi_client| |packageVersion|Rust crate version.| |null| +## SUPPORTED VENDOR EXTENSIONS + +| Extension name | Description | Applicable for | Default value | +| -------------- | ----------- | -------------- | ------------- | +|x-all-of-name|Specify the name of the generated allOf composed schema|MODEL|null| +|x-one-of-name|Specify the name of the generated oneOf composed schema|MODEL|null| +|x-is-one-of-interface|Generate the oneOf composed schema as a marker interface|MODEL|null| + + ## IMPORT MAPPING | Type/Alias | Imports | diff --git a/docs/generators/rust.md b/docs/generators/rust.md index 8d6cc44b8b986363aff9d9e6c3336866a1183430..8f5bdeac928ad115551d0463094d425c446ec002 100644 --- a/docs/generators/rust.md +++ b/docs/generators/rust.md @@ -28,6 +28,15 @@ These options may be applied as additional-properties (cli) or configOptions (pl |useSingleRequestParameter|Setting this property to true will generate functions with a single argument containing all API endpoint parameters instead of one argument per parameter.| |false| |withAWSV4Signature|whether to include AWS v4 signature support| |false| +## SUPPORTED VENDOR EXTENSIONS + +| Extension name | Description | Applicable for | Default value | +| -------------- | ----------- | -------------- | ------------- | +|x-all-of-name|Specify the name of the generated allOf composed schema|MODEL|null| +|x-one-of-name|Specify the name of the generated oneOf composed schema|MODEL|null| +|x-is-one-of-interface|Generate the oneOf composed schema as a marker interface|MODEL|null| + + ## IMPORT MAPPING | Type/Alias | Imports | diff --git a/docs/generators/scala-akka-http-server.md b/docs/generators/scala-akka-http-server.md index 3cbb4c8fb1db0fe5a5a8f717c76d09bfd0b25fb9..d8f9496e9fd1ab603a4067a5c231bd696dc76c57 100644 --- a/docs/generators/scala-akka-http-server.md +++ b/docs/generators/scala-akka-http-server.md @@ -38,6 +38,15 @@ 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| |null| +## SUPPORTED VENDOR EXTENSIONS + +| Extension name | Description | Applicable for | Default value | +| -------------- | ----------- | -------------- | ------------- | +|x-all-of-name|Specify the name of the generated allOf composed schema|MODEL|null| +|x-one-of-name|Specify the name of the generated oneOf composed schema|MODEL|null| +|x-is-one-of-interface|Generate the oneOf composed schema as a marker interface|MODEL|null| + + ## IMPORT MAPPING | Type/Alias | Imports | diff --git a/docs/generators/scala-akka.md b/docs/generators/scala-akka.md index b6ba593dcc456b02621724be47511710d9033dc2..1ed94b5b3e4a26c241e71aa80e82281abb7e61bc 100644 --- a/docs/generators/scala-akka.md +++ b/docs/generators/scala-akka.md @@ -33,6 +33,15 @@ 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| |null| +## SUPPORTED VENDOR EXTENSIONS + +| Extension name | Description | Applicable for | Default value | +| -------------- | ----------- | -------------- | ------------- | +|x-all-of-name|Specify the name of the generated allOf composed schema|MODEL|null| +|x-one-of-name|Specify the name of the generated oneOf composed schema|MODEL|null| +|x-is-one-of-interface|Generate the oneOf composed schema as a marker interface|MODEL|null| + + ## IMPORT MAPPING | Type/Alias | Imports | diff --git a/docs/generators/scala-finch.md b/docs/generators/scala-finch.md index 5ace1e1652f83616103aaeb02ec815476be5a3c8..5ae5442dd6d1043e4b907002cac76b2d0ae6dae1 100644 --- a/docs/generators/scala-finch.md +++ b/docs/generators/scala-finch.md @@ -22,6 +22,15 @@ These options may be applied as additional-properties (cli) or configOptions (pl |modelPackage|package for generated models| |null| |packageName|Finch package name (e.g. org.openapitools).| |org.openapitools| +## SUPPORTED VENDOR EXTENSIONS + +| Extension name | Description | Applicable for | Default value | +| -------------- | ----------- | -------------- | ------------- | +|x-all-of-name|Specify the name of the generated allOf composed schema|MODEL|null| +|x-one-of-name|Specify the name of the generated oneOf composed schema|MODEL|null| +|x-is-one-of-interface|Generate the oneOf composed schema as a marker interface|MODEL|null| + + ## IMPORT MAPPING | Type/Alias | Imports | diff --git a/docs/generators/scala-gatling.md b/docs/generators/scala-gatling.md index e3be5dfa0b50e7f381263c1fc8350eb079bc46ac..01147ef75ee8f3b006a23bf1ecb95b5c58a0a6ec 100644 --- a/docs/generators/scala-gatling.md +++ b/docs/generators/scala-gatling.md @@ -32,6 +32,15 @@ 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| |null| +## SUPPORTED VENDOR EXTENSIONS + +| Extension name | Description | Applicable for | Default value | +| -------------- | ----------- | -------------- | ------------- | +|x-all-of-name|Specify the name of the generated allOf composed schema|MODEL|null| +|x-one-of-name|Specify the name of the generated oneOf composed schema|MODEL|null| +|x-is-one-of-interface|Generate the oneOf composed schema as a marker interface|MODEL|null| + + ## IMPORT MAPPING | Type/Alias | Imports | diff --git a/docs/generators/scala-httpclient-deprecated.md b/docs/generators/scala-httpclient-deprecated.md index 35d8e770dbec653b7164b73af8f945d7fb263d85..fe20e6cd268f25cbc9109fb41b1b3f6577603c25 100644 --- a/docs/generators/scala-httpclient-deprecated.md +++ b/docs/generators/scala-httpclient-deprecated.md @@ -32,6 +32,15 @@ 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| |null| +## SUPPORTED VENDOR EXTENSIONS + +| Extension name | Description | Applicable for | Default value | +| -------------- | ----------- | -------------- | ------------- | +|x-all-of-name|Specify the name of the generated allOf composed schema|MODEL|null| +|x-one-of-name|Specify the name of the generated oneOf composed schema|MODEL|null| +|x-is-one-of-interface|Generate the oneOf composed schema as a marker interface|MODEL|null| + + ## IMPORT MAPPING | Type/Alias | Imports | diff --git a/docs/generators/scala-lagom-server.md b/docs/generators/scala-lagom-server.md index 0014d87fedb0360789c496aa14e41b6621556b82..1f5852d8a2fab34d13acb749a750d71b2c3b5306 100644 --- a/docs/generators/scala-lagom-server.md +++ b/docs/generators/scala-lagom-server.md @@ -32,6 +32,15 @@ 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| |null| +## SUPPORTED VENDOR EXTENSIONS + +| Extension name | Description | Applicable for | Default value | +| -------------- | ----------- | -------------- | ------------- | +|x-all-of-name|Specify the name of the generated allOf composed schema|MODEL|null| +|x-one-of-name|Specify the name of the generated oneOf composed schema|MODEL|null| +|x-is-one-of-interface|Generate the oneOf composed schema as a marker interface|MODEL|null| + + ## IMPORT MAPPING | Type/Alias | Imports | diff --git a/docs/generators/scala-play-server.md b/docs/generators/scala-play-server.md index 58562232a924c3ca7e8517af54bcb150749fd311..7aee478fdbcd9ff168a7c9d556e8dfb0da936b1f 100644 --- a/docs/generators/scala-play-server.md +++ b/docs/generators/scala-play-server.md @@ -37,6 +37,15 @@ These options may be applied as additional-properties (cli) or configOptions (pl |supportAsync|If set, wraps API return types with Futures and generates async actions.| |false| |useSwaggerUI|Add a route to /api which show your documentation in swagger-ui. Will also import needed dependencies| |true| +## SUPPORTED VENDOR EXTENSIONS + +| Extension name | Description | Applicable for | Default value | +| -------------- | ----------- | -------------- | ------------- | +|x-all-of-name|Specify the name of the generated allOf composed schema|MODEL|null| +|x-one-of-name|Specify the name of the generated oneOf composed schema|MODEL|null| +|x-is-one-of-interface|Generate the oneOf composed schema as a marker interface|MODEL|null| + + ## IMPORT MAPPING | Type/Alias | Imports | diff --git a/docs/generators/scala-sttp.md b/docs/generators/scala-sttp.md index 377862d9ca7a4bd476e1baeeea10baa4af8de536..c586892ac7b8720f5264a70f853c722637eb19da 100644 --- a/docs/generators/scala-sttp.md +++ b/docs/generators/scala-sttp.md @@ -38,6 +38,15 @@ These options may be applied as additional-properties (cli) or configOptions (pl |sourceFolder|source folder for generated code| |null| |sttpClientVersion|The version of sttp client| |3.3.18| +## SUPPORTED VENDOR EXTENSIONS + +| Extension name | Description | Applicable for | Default value | +| -------------- | ----------- | -------------- | ------------- | +|x-all-of-name|Specify the name of the generated allOf composed schema|MODEL|null| +|x-one-of-name|Specify the name of the generated oneOf composed schema|MODEL|null| +|x-is-one-of-interface|Generate the oneOf composed schema as a marker interface|MODEL|null| + + ## IMPORT MAPPING | Type/Alias | Imports | diff --git a/docs/generators/scalatra.md b/docs/generators/scalatra.md index 2a8b10482dc8e0ff0f1cbabdc9ace9217feed609..9678efd0074a30c8f7bfd904e61041b60228c156 100644 --- a/docs/generators/scalatra.md +++ b/docs/generators/scalatra.md @@ -32,6 +32,15 @@ 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| |null| +## SUPPORTED VENDOR EXTENSIONS + +| Extension name | Description | Applicable for | Default value | +| -------------- | ----------- | -------------- | ------------- | +|x-all-of-name|Specify the name of the generated allOf composed schema|MODEL|null| +|x-one-of-name|Specify the name of the generated oneOf composed schema|MODEL|null| +|x-is-one-of-interface|Generate the oneOf composed schema as a marker interface|MODEL|null| + + ## IMPORT MAPPING | Type/Alias | Imports | diff --git a/docs/generators/scalaz.md b/docs/generators/scalaz.md index 6916c86fe9f9c3100d42c40a059124d92ed563d9..9613589749d4392997218e5a97d31072a2edc5ca 100644 --- a/docs/generators/scalaz.md +++ b/docs/generators/scalaz.md @@ -32,6 +32,15 @@ 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| |null| +## SUPPORTED VENDOR EXTENSIONS + +| Extension name | Description | Applicable for | Default value | +| -------------- | ----------- | -------------- | ------------- | +|x-all-of-name|Specify the name of the generated allOf composed schema|MODEL|null| +|x-one-of-name|Specify the name of the generated oneOf composed schema|MODEL|null| +|x-is-one-of-interface|Generate the oneOf composed schema as a marker interface|MODEL|null| + + ## IMPORT MAPPING | Type/Alias | Imports | diff --git a/docs/generators/spring.md b/docs/generators/spring.md index 5222fa8c5297e8f0df521b961fe989f0179a27a8..095ef720484d353fdbf10b75fc917d5051df2ec6 100644 --- a/docs/generators/spring.md +++ b/docs/generators/spring.md @@ -93,15 +93,18 @@ These options may be applied as additional-properties (cli) or configOptions (pl | Extension name | Description | Applicable for | Default value | | -------------- | ----------- | -------------- | ------------- | -|x-discriminator-value|Used with model inheritance to specify value for discriminator that identifies current model|MODEL| -|x-implements|Ability to specify interfaces that model must implements|MODEL|empty array -|x-setter-extra-annotation|Custom annotation that can be specified over java setter for specific field|FIELD|When field is array & uniqueItems, then this extension is used to add `@JsonDeserialize(as = LinkedHashSet.class)` over setter, otherwise no value -|x-tags|Specify multiple swagger tags for operation|OPERATION|null -|x-accepts|Specify custom value for 'Accept' header for operation|OPERATION|null -|x-content-type|Specify custom value for 'Content-Type' header for operation|OPERATION|null -|x-class-extra-annotation|List of custom annotations to be added to model|MODEL|null -|x-field-extra-annotation|List of custom annotations to be added to property|FIELD|null -|x-spring-paginated|Add org.springframework.data.domain.Pageable to controller method. Can be used to handle page & size query parameters|OPERATION|false +|x-all-of-name|Specify the name of the generated allOf composed schema|MODEL|null| +|x-one-of-name|Specify the name of the generated oneOf composed schema|MODEL|null| +|x-is-one-of-interface|Generate the oneOf composed schema as a marker interface|MODEL|null| +|x-discriminator-value|Used with model inheritance to specify value for discriminator that identifies current model|MODEL|| +|x-implements|Ability to specify interfaces that model must implements|MODEL|empty array| +|x-setter-extra-annotation|Custom annotation that can be specified over java setter for specific field|FIELD|When field is array & uniqueItems, then this extension is used to add `@JsonDeserialize(as = LinkedHashSet.class)` over setter, otherwise no value| +|x-tags|Specify multiple swagger tags for operation|OPERATION|null| +|x-accepts|Specify custom value for 'Accept' header for operation|OPERATION|null| +|x-content-type|Specify custom value for 'Content-Type' header for operation|OPERATION|null| +|x-class-extra-annotation|List of custom annotations to be added to model|MODEL|null| +|x-field-extra-annotation|List of custom annotations to be added to property|FIELD|null| +|x-spring-paginated|Add org.springframework.data.domain.Pageable to controller method. Can be used to handle page & size query parameters|OPERATION|false| ## IMPORT MAPPING diff --git a/docs/generators/swift5.md b/docs/generators/swift5.md index 5f79e7ae5c316c3fce8f032ecbeb38034c8f1a7f..7d5c7726a419eee6c78fb3a3b4c5db868ef9a729 100644 --- a/docs/generators/swift5.md +++ b/docs/generators/swift5.md @@ -55,6 +55,15 @@ These options may be applied as additional-properties (cli) or configOptions (pl |useClasses|Use final classes for models instead of structs (default: false)| |false| |useSPMFileStructure|Use SPM file structure and set the source path to Sources/{{projectName}} (default: false).| |null| +## SUPPORTED VENDOR EXTENSIONS + +| Extension name | Description | Applicable for | Default value | +| -------------- | ----------- | -------------- | ------------- | +|x-all-of-name|Specify the name of the generated allOf composed schema|MODEL|null| +|x-one-of-name|Specify the name of the generated oneOf composed schema|MODEL|null| +|x-is-one-of-interface|Generate the oneOf composed schema as a marker interface|MODEL|null| + + ## IMPORT MAPPING | Type/Alias | Imports | diff --git a/docs/generators/typescript-angular.md b/docs/generators/typescript-angular.md index da3b85271d922650e0e6c8addf04aaae8f34f0ba..7eefd5fff68824ac9c92feb149c25db987350292 100644 --- a/docs/generators/typescript-angular.md +++ b/docs/generators/typescript-angular.md @@ -51,6 +51,15 @@ These options may be applied as additional-properties (cli) or configOptions (pl |useSingleRequestParameter|Setting this property to true will generate functions with a single argument containing all API endpoint parameters instead of one argument per parameter.| |false| |withInterfaces|Setting this property to true will generate interfaces next to the default class implementations.| |false| +## SUPPORTED VENDOR EXTENSIONS + +| Extension name | Description | Applicable for | Default value | +| -------------- | ----------- | -------------- | ------------- | +|x-all-of-name|Specify the name of the generated allOf composed schema|MODEL|null| +|x-one-of-name|Specify the name of the generated oneOf composed schema|MODEL|null| +|x-is-one-of-interface|Generate the oneOf composed schema as a marker interface|MODEL|null| + + ## IMPORT MAPPING | Type/Alias | Imports | diff --git a/docs/generators/typescript-aurelia.md b/docs/generators/typescript-aurelia.md index 1acd1fca0316e2042dd9d0938a17684d12b6e54c..6d22ea4f52a8fa2de6c3dd6ee0559a9cef65b08d 100644 --- a/docs/generators/typescript-aurelia.md +++ b/docs/generators/typescript-aurelia.md @@ -36,6 +36,15 @@ These options may be applied as additional-properties (cli) or configOptions (pl |sortParamsByRequiredFlag|Sort method arguments to place required parameters before optional parameters.| |true| |supportsES6|Generate code that conforms to ES6.| |false| +## SUPPORTED VENDOR EXTENSIONS + +| Extension name | Description | Applicable for | Default value | +| -------------- | ----------- | -------------- | ------------- | +|x-all-of-name|Specify the name of the generated allOf composed schema|MODEL|null| +|x-one-of-name|Specify the name of the generated oneOf composed schema|MODEL|null| +|x-is-one-of-interface|Generate the oneOf composed schema as a marker interface|MODEL|null| + + ## IMPORT MAPPING | Type/Alias | Imports | diff --git a/docs/generators/typescript-axios.md b/docs/generators/typescript-axios.md index a205ff3f799952cc633873e5b5eede859e18d94b..3eb7f7eb1649f88243df42651f57f5e7ca2d85de 100644 --- a/docs/generators/typescript-axios.md +++ b/docs/generators/typescript-axios.md @@ -42,6 +42,15 @@ These options may be applied as additional-properties (cli) or configOptions (pl |withSeparateModelsAndApi|Put the model and api in separate folders and in separate classes| |false| |withoutPrefixEnums|Don't prefix enum names with class names| |false| +## SUPPORTED VENDOR EXTENSIONS + +| Extension name | Description | Applicable for | Default value | +| -------------- | ----------- | -------------- | ------------- | +|x-all-of-name|Specify the name of the generated allOf composed schema|MODEL|null| +|x-one-of-name|Specify the name of the generated oneOf composed schema|MODEL|null| +|x-is-one-of-interface|Generate the oneOf composed schema as a marker interface|MODEL|null| + + ## IMPORT MAPPING | Type/Alias | Imports | diff --git a/docs/generators/typescript-fetch.md b/docs/generators/typescript-fetch.md index 60bf5ef5d71af0da81b99cc6735ba1ca81c68530..d37eb51f4eed9f35d9b8fced27f6f2c40e43b123 100644 --- a/docs/generators/typescript-fetch.md +++ b/docs/generators/typescript-fetch.md @@ -44,6 +44,15 @@ These options may be applied as additional-properties (cli) or configOptions (pl |withInterfaces|Setting this property to true will generate interfaces next to the default class implementations.| |false| |withoutRuntimeChecks|Setting this property to true will remove any runtime checks on the request and response payloads. Payloads will be casted to their expected types.| |false| +## SUPPORTED VENDOR EXTENSIONS + +| Extension name | Description | Applicable for | Default value | +| -------------- | ----------- | -------------- | ------------- | +|x-all-of-name|Specify the name of the generated allOf composed schema|MODEL|null| +|x-one-of-name|Specify the name of the generated oneOf composed schema|MODEL|null| +|x-is-one-of-interface|Generate the oneOf composed schema as a marker interface|MODEL|null| + + ## IMPORT MAPPING | Type/Alias | Imports | diff --git a/docs/generators/typescript-inversify.md b/docs/generators/typescript-inversify.md index a6df7b684148b54d7a11ad827649334b9617d517..db1b0adc2f900d001fdcbd6612d2947fde0b52e5 100644 --- a/docs/generators/typescript-inversify.md +++ b/docs/generators/typescript-inversify.md @@ -41,6 +41,15 @@ These options may be applied as additional-properties (cli) or configOptions (pl |useRxJS6|Setting this property to use rxjs 6 instead of rxjs 5.| |false| |withInterfaces|Setting this property to true will generate interfaces next to the default class implementations.| |false| +## SUPPORTED VENDOR EXTENSIONS + +| Extension name | Description | Applicable for | Default value | +| -------------- | ----------- | -------------- | ------------- | +|x-all-of-name|Specify the name of the generated allOf composed schema|MODEL|null| +|x-one-of-name|Specify the name of the generated oneOf composed schema|MODEL|null| +|x-is-one-of-interface|Generate the oneOf composed schema as a marker interface|MODEL|null| + + ## IMPORT MAPPING | Type/Alias | Imports | diff --git a/docs/generators/typescript-jquery.md b/docs/generators/typescript-jquery.md index f9614b9384f0e705cdd4ecb9401eb4b1dd48f5f8..6bbe8985729705ba4b5008770dc5bf0f875ca208 100644 --- a/docs/generators/typescript-jquery.md +++ b/docs/generators/typescript-jquery.md @@ -38,6 +38,15 @@ These options may be applied as additional-properties (cli) or configOptions (pl |sortParamsByRequiredFlag|Sort method arguments to place required parameters before optional parameters.| |true| |supportsES6|Generate code that conforms to ES6.| |false| +## SUPPORTED VENDOR EXTENSIONS + +| Extension name | Description | Applicable for | Default value | +| -------------- | ----------- | -------------- | ------------- | +|x-all-of-name|Specify the name of the generated allOf composed schema|MODEL|null| +|x-one-of-name|Specify the name of the generated oneOf composed schema|MODEL|null| +|x-is-one-of-interface|Generate the oneOf composed schema as a marker interface|MODEL|null| + + ## IMPORT MAPPING | Type/Alias | Imports | diff --git a/docs/generators/typescript-nestjs.md b/docs/generators/typescript-nestjs.md index 0e00ef4f247d98c0b5b799bc281e58e5d6f38ced..4a43e034e6dbffe08b4c0111f3e2af052eef6992 100644 --- a/docs/generators/typescript-nestjs.md +++ b/docs/generators/typescript-nestjs.md @@ -46,6 +46,15 @@ These options may be applied as additional-properties (cli) or configOptions (pl |taggedUnions|Use discriminators to create tagged unions instead of extending interfaces.| |false| |withInterfaces|Setting this property to true will generate interfaces next to the default class implementations.| |false| +## SUPPORTED VENDOR EXTENSIONS + +| Extension name | Description | Applicable for | Default value | +| -------------- | ----------- | -------------- | ------------- | +|x-all-of-name|Specify the name of the generated allOf composed schema|MODEL|null| +|x-one-of-name|Specify the name of the generated oneOf composed schema|MODEL|null| +|x-is-one-of-interface|Generate the oneOf composed schema as a marker interface|MODEL|null| + + ## IMPORT MAPPING | Type/Alias | Imports | diff --git a/docs/generators/typescript-node.md b/docs/generators/typescript-node.md index 54dcee73307527d9498f3d5450cf496c19cda2b1..58a75a486bf05d3e82a6d08cebefcf88b3e0cf38 100644 --- a/docs/generators/typescript-node.md +++ b/docs/generators/typescript-node.md @@ -37,6 +37,15 @@ These options may be applied as additional-properties (cli) or configOptions (pl |sortParamsByRequiredFlag|Sort method arguments to place required parameters before optional parameters.| |true| |supportsES6|Generate code that conforms to ES6.| |false| +## SUPPORTED VENDOR EXTENSIONS + +| Extension name | Description | Applicable for | Default value | +| -------------- | ----------- | -------------- | ------------- | +|x-all-of-name|Specify the name of the generated allOf composed schema|MODEL|null| +|x-one-of-name|Specify the name of the generated oneOf composed schema|MODEL|null| +|x-is-one-of-interface|Generate the oneOf composed schema as a marker interface|MODEL|null| + + ## IMPORT MAPPING | Type/Alias | Imports | diff --git a/docs/generators/typescript-redux-query.md b/docs/generators/typescript-redux-query.md index f219e8a3e5e6463e5c5bad7963154439b1585eae..5ff1687f65225656cd7d6f3a235c253770cdb78c 100644 --- a/docs/generators/typescript-redux-query.md +++ b/docs/generators/typescript-redux-query.md @@ -39,6 +39,15 @@ These options may be applied as additional-properties (cli) or configOptions (pl |useSingleRequestParameter|Setting this property to true will generate functions with a single argument containing all API endpoint parameters instead of one argument per parameter.| |true| |withInterfaces|Setting this property to true will generate interfaces next to the default class implementations.| |false| +## SUPPORTED VENDOR EXTENSIONS + +| Extension name | Description | Applicable for | Default value | +| -------------- | ----------- | -------------- | ------------- | +|x-all-of-name|Specify the name of the generated allOf composed schema|MODEL|null| +|x-one-of-name|Specify the name of the generated oneOf composed schema|MODEL|null| +|x-is-one-of-interface|Generate the oneOf composed schema as a marker interface|MODEL|null| + + ## IMPORT MAPPING | Type/Alias | Imports | diff --git a/docs/generators/typescript-rxjs.md b/docs/generators/typescript-rxjs.md index 93aca0c5f8123bc54e609a3b94d73162f5633de8..02cce986ca6e4fcd81ebc142bbc1d7787e82e19a 100644 --- a/docs/generators/typescript-rxjs.md +++ b/docs/generators/typescript-rxjs.md @@ -38,6 +38,15 @@ These options may be applied as additional-properties (cli) or configOptions (pl |supportsES6|Generate code that conforms to ES6.| |false| |withProgressSubscriber|Setting this property to true will generate API controller methods with support for subscribing to request progress.| |false| +## SUPPORTED VENDOR EXTENSIONS + +| Extension name | Description | Applicable for | Default value | +| -------------- | ----------- | -------------- | ------------- | +|x-all-of-name|Specify the name of the generated allOf composed schema|MODEL|null| +|x-one-of-name|Specify the name of the generated oneOf composed schema|MODEL|null| +|x-is-one-of-interface|Generate the oneOf composed schema as a marker interface|MODEL|null| + + ## IMPORT MAPPING | Type/Alias | Imports | diff --git a/docs/generators/typescript.md b/docs/generators/typescript.md index 9d0e683f41a3b2d48e46df9bd5f2fb9567712953..3331f028c544e8b42ddd50cde1e92ae314c41fcb 100644 --- a/docs/generators/typescript.md +++ b/docs/generators/typescript.md @@ -39,6 +39,15 @@ These options may be applied as additional-properties (cli) or configOptions (pl |useObjectParameters|Use aggregate parameter objects as function arguments for api operations instead of passing each parameter as a separate function argument.| |false| |useRxJS|Enable this to internally use rxjs observables. If disabled, a stub is used instead. This is required for the 'angular' framework.| |false| +## SUPPORTED VENDOR EXTENSIONS + +| Extension name | Description | Applicable for | Default value | +| -------------- | ----------- | -------------- | ------------- | +|x-all-of-name|Specify the name of the generated allOf composed schema|MODEL|null| +|x-one-of-name|Specify the name of the generated oneOf composed schema|MODEL|null| +|x-is-one-of-interface|Generate the oneOf composed schema as a marker interface|MODEL|null| + + ## IMPORT MAPPING | Type/Alias | Imports | diff --git a/docs/generators/wsdl-schema.md b/docs/generators/wsdl-schema.md index e54072e733555fc1d8f89eb83f00d8e4beadadfb..55b4fc507ff176947f6643b66bb62e56f36d3ee2 100644 --- a/docs/generators/wsdl-schema.md +++ b/docs/generators/wsdl-schema.md @@ -30,6 +30,16 @@ 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| +## SUPPORTED VENDOR EXTENSIONS + +| Extension name | Description | Applicable for | Default value | +| -------------- | ----------- | -------------- | ------------- | +|x-all-of-name|Specify the name of the generated allOf composed schema|MODEL|null| +|x-one-of-name|Specify the name of the generated oneOf composed schema|MODEL|null| +|x-is-one-of-interface|Generate the oneOf composed schema as a marker interface|MODEL|null| +|x-oneof-schemas|Generate ...|MODEL|null| + + ## IMPORT MAPPING | Type/Alias | Imports | diff --git a/modules/openapi-generator-cli/src/main/java/org/openapitools/codegen/cmd/ConfigHelp.java b/modules/openapi-generator-cli/src/main/java/org/openapitools/codegen/cmd/ConfigHelp.java index 29247f4256d4ced818ce9d251e6aa4615a4ba839..ad366d6c92fec52036c8c3e13a9ffd2992a4633a 100644 --- a/modules/openapi-generator-cli/src/main/java/org/openapitools/codegen/cmd/ConfigHelp.java +++ b/modules/openapi-generator-cli/src/main/java/org/openapitools/codegen/cmd/ConfigHelp.java @@ -220,7 +220,7 @@ public class ConfigHelp extends OpenApiGeneratorCommand { .append("|").append(extension.getDescription()) .append("|").append(extension.getLevels().stream().map(Objects::toString).collect(Collectors.joining(", "))) .append("|").append(extension.getDefaultValue()) - .append(newline) + .append("|").append(newline) ); sb.append(newline); } diff --git a/modules/openapi-generator/src/main/java/org/openapitools/codegen/DefaultCodegen.java b/modules/openapi-generator/src/main/java/org/openapitools/codegen/DefaultCodegen.java index 2e1b2e6fa5b25f37ea2ae32a12e52420867b842f..c2d9e21885be0adf94d5a850ccb516036c478692 100644 --- a/modules/openapi-generator/src/main/java/org/openapitools/codegen/DefaultCodegen.java +++ b/modules/openapi-generator/src/main/java/org/openapitools/codegen/DefaultCodegen.java @@ -459,7 +459,7 @@ public class DefaultCodegen implements CodegenConfig { for (ModelMap mo : modelsAttrs.getModels()) { CodegenModel cm = mo.getModel(); if (cm.oneOf.size() > 0) { - cm.vendorExtensions.put("x-is-one-of-interface", true); + cm.vendorExtensions.put(VendorExtension.X_IS_ONE_OF_INTERFACE.getName(), true); for (String one : cm.oneOf) { if (!additionalDataMap.containsKey(one)) { additionalDataMap.put(one, new OneOfImplementorAdditionalData(one)); @@ -2093,8 +2093,8 @@ public class DefaultCodegen implements CodegenConfig { @SuppressWarnings("static-method") public String toAllOfName(List<String> names, ComposedSchema composedSchema) { Map<String, Object> exts = composedSchema.getExtensions(); - if (exts != null && exts.containsKey("x-all-of-name")) { - return (String) exts.get("x-all-of-name"); + if (exts != null && exts.containsKey(VendorExtension.X_ALL_OF_NAME.getName())) { + return (String) exts.get(VendorExtension.X_ALL_OF_NAME.getName()); } if (names.size() == 0) { LOGGER.error("allOf has no member defined: {}. Default to ERROR_ALLOF_SCHEMA", composedSchema); @@ -2135,8 +2135,8 @@ public class DefaultCodegen implements CodegenConfig { @SuppressWarnings("static-method") public String toOneOfName(List<String> names, ComposedSchema composedSchema) { Map<String, Object> exts = composedSchema.getExtensions(); - if (exts != null && exts.containsKey("x-one-of-name")) { - return (String) exts.get("x-one-of-name"); + if (exts != null && exts.containsKey(VendorExtension.X_ONE_OF_NAME.getName())) { + return (String) exts.get(VendorExtension.X_ONE_OF_NAME.getName()); } return "oneOf<" + String.join(",", names) + ">"; } @@ -7125,7 +7125,7 @@ public class DefaultCodegen implements CodegenConfig { */ public void addOneOfNameExtension(ComposedSchema s, String name) { if (s.getOneOf() != null && s.getOneOf().size() > 0) { - s.addExtension("x-one-of-name", name); + s.addExtension(VendorExtension.X_ONE_OF_NAME.getName(), name); } } @@ -7162,7 +7162,7 @@ public class DefaultCodegen implements CodegenConfig { } cm.name = type; cm.classname = type; - cm.vendorExtensions.put("x-is-one-of-interface", true); + cm.vendorExtensions.put(VendorExtension.X_IS_ONE_OF_INTERFACE.getName(), true); cm.interfaceModels = new ArrayList<>(); addOneOfInterfaces.add(cm); @@ -7405,6 +7405,10 @@ public class DefaultCodegen implements CodegenConfig { @Override public List<VendorExtension> getSupportedVendorExtensions() { - return new ArrayList<>(); + List<VendorExtension> supportedVendorExtensions = new ArrayList<>(); + supportedVendorExtensions.add(VendorExtension.X_ALL_OF_NAME); + supportedVendorExtensions.add(VendorExtension.X_ONE_OF_NAME); + supportedVendorExtensions.add(VendorExtension.X_IS_ONE_OF_INTERFACE); + return supportedVendorExtensions; } } diff --git a/modules/openapi-generator/src/main/java/org/openapitools/codegen/VendorExtension.java b/modules/openapi-generator/src/main/java/org/openapitools/codegen/VendorExtension.java index b662fe0006cc0960935196b5842847fe15dd65bb..5788adf5cb3ab9a29cda3c1c958cd7794c07965d 100644 --- a/modules/openapi-generator/src/main/java/org/openapitools/codegen/VendorExtension.java +++ b/modules/openapi-generator/src/main/java/org/openapitools/codegen/VendorExtension.java @@ -7,7 +7,6 @@ public enum VendorExtension { X_IMPLEMENTS("x-implements", ExtensionLevel.MODEL, "Ability to specify interfaces that model must implements", "empty array"), X_SPRING_PAGINATED("x-spring-paginated", ExtensionLevel.OPERATION, "Add org.springframework.data.domain.Pageable to controller method. Can be used to handle page & size query parameters", "false"), - X_DISCRIMINATOR_VALUE("x-discriminator-value", ExtensionLevel.MODEL, "Used with model inheritance to specify value for discriminator that identifies current model", ""), X_SETTER_EXTRA_ANNOTATION("x-setter-extra-annotation", ExtensionLevel.FIELD, "Custom annotation that can be specified over java setter for specific field", "When field is array & uniqueItems, then this extension is used to add `@JsonDeserialize(as = LinkedHashSet.class)` over setter, otherwise no value"), X_WEBCLIENT_BLOCKING("x-webclient-blocking", ExtensionLevel.OPERATION, "Specifies if method for specific operation should be blocking or non-blocking(ex: return `Mono<T>/Flux<T>` or `return T/List<T>/Set<T>` & execute `.block()` inside generated method)", "false"), X_TAGS("x-tags", ExtensionLevel.OPERATION, "Specify multiple swagger tags for operation", null), @@ -15,7 +14,11 @@ public enum VendorExtension { X_CONTENT_TYPE("x-content-type", ExtensionLevel.OPERATION, "Specify custom value for 'Content-Type' header for operation", null), X_CLASS_EXTRA_ANNOTATION("x-class-extra-annotation", ExtensionLevel.MODEL, "List of custom annotations to be added to model", null), X_FIELD_EXTRA_ANNOTATION("x-field-extra-annotation", ExtensionLevel.FIELD, "List of custom annotations to be added to property", null), - ; + X_DISCRIMINATOR_VALUE("x-discriminator-value", ExtensionLevel.MODEL, "Used with model inheritance to specify value for discriminator that identifies current model", ""), + X_ALL_OF_NAME("x-all-of-name", ExtensionLevel.MODEL, "Specify the name of the generated allOf composed schema", null), + X_ONE_OF_NAME("x-one-of-name", ExtensionLevel.MODEL, "Specify the name of the generated oneOf composed schema", null), + X_IS_ONE_OF_INTERFACE("x-is-one-of-interface", ExtensionLevel.MODEL, "Generate the oneOf composed schema as a marker interface", null), + X_ONEOF_SCHEMAS("x-oneof-schemas", ExtensionLevel.MODEL, "Generate ...", null); private final String name; private final List<ExtensionLevel> levels; diff --git a/modules/openapi-generator/src/main/java/org/openapitools/codegen/languages/WsdlSchemaCodegen.java b/modules/openapi-generator/src/main/java/org/openapitools/codegen/languages/WsdlSchemaCodegen.java index bd803f4b97cb32eadf523481becfe831d6aac598..fad3575f7e876ba0207157378ec32d1a981c0f08 100644 --- a/modules/openapi-generator/src/main/java/org/openapitools/codegen/languages/WsdlSchemaCodegen.java +++ b/modules/openapi-generator/src/main/java/org/openapitools/codegen/languages/WsdlSchemaCodegen.java @@ -224,7 +224,7 @@ public class WsdlSchemaCodegen extends DefaultCodegen implements CodegenConfig { oneofSchemas.set(i, lowerCaseStringExceptFirstLetter(oneofSchemas.get(i))); } - propertyVendorExtensions.put("x-oneof-schemas", oneofSchemas); + propertyVendorExtensions.put(VendorExtension.X_ONEOF_SCHEMAS.getName(), oneofSchemas); } } } @@ -282,4 +282,11 @@ public class WsdlSchemaCodegen extends DefaultCodegen implements CodegenConfig { @Override public GeneratorLanguage generatorLanguage() { return GeneratorLanguage.WSDL; } + + @Override + public List<VendorExtension> getSupportedVendorExtensions() { + List<VendorExtension> supportedVendorExtensions = super.getSupportedVendorExtensions(); + supportedVendorExtensions.add(VendorExtension.X_ONEOF_SCHEMAS); + return supportedVendorExtensions; + } }