@@ -150,8 +148,8 @@ The OpenAPI Specification has undergone 3 revisions since initial creation in 20
| OpenAPI Generator Version | Release Date | Notes |
| --------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------ | ------------------------------------------------- |
-| 7.16.0 (upcoming minor release) [SNAPSHOT](https://oss.sonatype.org/content/repositories/snapshots/org/openapitools/openapi-generator-cli/7.16.0-SNAPSHOT/) | 22.09.2025 | Minor release with breaking changes (with fallback) |
-| [7.15.0](https://github.com/OpenAPITools/openapi-generator/releases/tag/v7.15.0) (latest stable release) | 22.08.2025 | Minor release with breaking changes (with fallback) |
+| 7.18.0 (upcoming minor release) [SNAPSHOT](https://github.com/OpenAPITools/openapi-generator/wiki/FAQ#how-to-test-with-the-latest-master-of-openapi-generator) | 10.12.2025 | Minor release with breaking changes (with fallback) |
+| [7.17.0](https://github.com/OpenAPITools/openapi-generator/releases/tag/v7.17.0) (latest stable release) | 29.10.2025 | Minor release with breaking changes (with fallback) |
| [6.6.0](https://github.com/OpenAPITools/openapi-generator/releases/tag/v6.6.0) | 11.05.2023 | Minor release with breaking changes (with fallback) |
| [5.4.0](https://github.com/OpenAPITools/openapi-generator/releases/tag/v5.4.0) | 31.01.2022 | Minor release with breaking changes (with fallback) |
| [4.3.1](https://github.com/OpenAPITools/openapi-generator/releases/tag/v4.3.1) | 06.05.2020 | Patch release (enhancements, bug fixes, etc) |
@@ -214,16 +212,16 @@ See the different versions of the [openapi-generator-cli](https://search.maven.o
If you're looking for the latest stable version, you can grab it directly from Maven.org (Java 11 runtime at a minimum):
-JAR location: `https://repo1.maven.org/maven2/org/openapitools/openapi-generator-cli/7.15.0/openapi-generator-cli-7.15.0.jar`
+JAR location: `https://repo1.maven.org/maven2/org/openapitools/openapi-generator-cli/7.17.0/openapi-generator-cli-7.17.0.jar`
For **Mac/Linux** users:
```sh
-wget https://repo1.maven.org/maven2/org/openapitools/openapi-generator-cli/7.15.0/openapi-generator-cli-7.15.0.jar -O openapi-generator-cli.jar
+wget https://repo1.maven.org/maven2/org/openapitools/openapi-generator-cli/7.17.0/openapi-generator-cli-7.17.0.jar -O openapi-generator-cli.jar
```
For **Windows** users, you will need to install [wget](http://gnuwin32.sourceforge.net/packages/wget.htm) or you can use Invoke-WebRequest in PowerShell (3.0+), e.g.
```
-Invoke-WebRequest -OutFile openapi-generator-cli.jar https://repo1.maven.org/maven2/org/openapitools/openapi-generator-cli/7.15.0/openapi-generator-cli-7.15.0.jar
+Invoke-WebRequest -OutFile openapi-generator-cli.jar https://repo1.maven.org/maven2/org/openapitools/openapi-generator-cli/7.17.0/openapi-generator-cli-7.17.0.jar
```
After downloading the JAR, run `java -jar openapi-generator-cli.jar help` to show the usage.
@@ -458,7 +456,7 @@ openapi-generator-cli version
To use a specific version of "openapi-generator-cli"
```sh
-openapi-generator-cli version-manager set 7.15.0
+openapi-generator-cli version-manager set 7.17.0
```
Or install it as dev-dependency:
@@ -482,7 +480,7 @@ pip install openapi-generator-cli
To install a specific version
```
-pip install openapi-generator-cli==7.15.0
+pip install openapi-generator-cli==7.17.0
```
You can also install with [jdk4py](https://github.com/activeviam/jdk4py) instead of java binary. (python>=3.10 is required)
@@ -508,7 +506,7 @@ java -jar modules/openapi-generator-cli/target/openapi-generator-cli.jar generat
(if you're on Windows, replace the last command with `java -jar modules\openapi-generator-cli\target\openapi-generator-cli.jar generate -i https://raw.githubusercontent.com/openapitools/openapi-generator/master/modules/openapi-generator/src/test/resources/3_0/petstore.yaml -g php -o c:\temp\php_api_client`)
-You can also download the JAR (latest release) directly from [maven.org](https://repo1.maven.org/maven2/org/openapitools/openapi-generator-cli/7.15.0/openapi-generator-cli-7.15.0.jar)
+You can also download the JAR (latest release) directly from [maven.org](https://repo1.maven.org/maven2/org/openapitools/openapi-generator-cli/7.17.0/openapi-generator-cli-7.17.0.jar)
To get a list of **general** options available, please run `java -jar modules/openapi-generator-cli/target/openapi-generator-cli.jar help generate`
@@ -1143,6 +1141,7 @@ Here is a list of template creators:
* Haskell Servant: @algas
* Haskell Yesod: @yotsuya
* Java Camel: @carnevalegiacomo
+ * Java Dubbo: @redoom
* Java MSF4J: @sanjeewa-malalgoda
* Java Spring Boot: @diyfr
* Java Undertow: @stevehu
@@ -1183,6 +1182,7 @@ Here is a list of template creators:
* Scala Finch: @jimschubert [:heart:](https://www.patreon.com/jimschubert)
* Scala Lagom: @gmkumar2005
* Scala Play: @adigerber
+ * TypeScript NestJS: @aryobenholzner
* Documentation
* AsciiDoc: @man-at-home
* HTML Doc 2: @jhitchcock
@@ -1259,7 +1259,7 @@ If you want to join the committee, please kindly apply by sending an email to te
| JMeter | @kannkyo (2021/01) |
| Jetbrains HTTP Client | @jlengrand (2023/01) |
| Julia | @tanmaykm (2023/01) |
-| Kotlin | @dr4ke616 (2018/08) @karismann (2019/03) @Zomzog (2019/04) @andrewemery (2019/10) @4brunu (2019/11) @yutaka0m (2020/03) @stefankoppier (2022/06) @e5l (2024/10) |
+| Kotlin | @karismann (2019/03) @Zomzog (2019/04) @andrewemery (2019/10) @4brunu (2019/11) @yutaka0m (2020/03) @stefankoppier (2022/06) @e5l (2024/10) |
| Lua | @daurnimator (2017/08) |
| N4JS | @mmews-n4 (2023/03) |
| Nim | |
diff --git a/appveyor.yml b/appveyor.yml
deleted file mode 100644
index 3c6471ae7a77..000000000000
--- a/appveyor.yml
+++ /dev/null
@@ -1,119 +0,0 @@
-version: '{branch}-{build}'
-image: Visual Studio 2022
-hosts:
- petstore.swagger.io: 127.0.0.1
-install:
- - cmd: SET PATH=C:\maven\apache-maven-3.8.3\bin;C:\gradle\gradle-7.6\bin;%JAVA_HOME%\bin;%PATH%
- - cmd: SET MAVEN_OPTS=-Xmx4g
- - cmd: SET JAVA_OPTS=-Xmx4g
- - cmd: SET M2_HOME=C:\maven\apache-maven-3.8.3
- - cmd: java -version
- - cmd: dir/w
- - cmd: docker pull swaggerapi/petstore
- - cmd: docker run -d -e SWAGGER_HOST=http://petstore.swagger.io -e SWAGGER_BASE_PATH=/v2 -p 80:8080 swaggerapi/petstore
- - ps: Start-Sleep -s 120
- - ps: $PSVersionTable.PSVersion
- - ps: Install-Module -Name Pester -Force -Scope CurrentUser -SkipPublisherCheck
-build_script:
- - dotnet --info
- # build C# aspnetcore 5.0 server
- #- dotnet build samples\server\petstore\aspnetcore-5.0\Org.OpenAPITools.sln
- ## build C# aspnetcore 3.1 server
- #- dotnet build samples\server\petstore\aspnetcore-3.1\Org.OpenAPITools.sln
- ## build C# aspnetcore 3.0 server
- #- dotnet build samples\server\petstore\aspnetcore-3.0\Org.OpenAPITools.sln
- ## build C# aspnetcore 2.2 server
- #- dotnet build samples\server\petstore\aspnetcore\Org.OpenAPITools.sln
- ## build C# API client (multiple frameworks)
- #- dotnet build samples\client\petstore\csharp\OpenAPIClientCoreAndNet47\Org.OpenAPITools.sln
- ## build C# API client (httpclient)
- #- dotnet build samples\client\petstore\csharp\OpenAPIClient-httpclient\Org.OpenAPITools.sln
- ## build C# API client (generichost)
- #- dotnet build samples\client\petstore\csharp\OpenAPIClient-generichost-netstandard2.0\Org.OpenAPITools.sln
- ## build C# API client (netcore)
- #- dotnet build samples\client\petstore\csharp\OpenAPIClient\Org.OpenAPITools.sln
- #- dotnet build samples\client\petstore\csharp\OpenAPIClientCore\Org.OpenAPITools.sln
- ## build C# API client (.net framework 4.7)
- #- dotnet build samples\client\petstore\csharp\OpenAPIClient-net47\Org.OpenAPITools.sln
- ## build C# API client (.net framework 4.8)
- #- dotnet build samples\client\petstore\csharp\OpenAPIClient-net48\Org.OpenAPITools.sln
- ## build C# API client (.net 5.0)
- #- dotnet build samples\client\petstore\csharp\OpenAPIClient-net5.0\Org.OpenAPITools.sln
- ## build C# API client (.net 5.0 with ConditionalSerialization)
- #- dotnet build samples\client\petstore\csharp\OpenAPIClient-ConditionalSerialization\Org.OpenAPITools.sln
-
-test_script:
- - dotnet test samples\client\petstore\csharp\generichost\latest\ComposedEnum\src\Org.OpenAPITools.Test\Org.OpenAPITools.Test.csproj
- - dotnet test samples\client\petstore\csharp\generichost\latest\InlineEnumAnyOf\src\Org.OpenAPITools.Test\Org.OpenAPITools.Test.csproj
- - dotnet test samples\client\petstore\csharp\generichost\latest\Tags\src\Org.OpenAPITools.Test\Org.OpenAPITools.Test.csproj
- - dotnet test samples\client\petstore\csharp\generichost\latest\HelloWorld\src\Org.OpenAPITools.Test\Org.OpenAPITools.Test.csproj
- - dotnet test samples\client\petstore\csharp\generichost\latest\OneOfList\src\Org.OpenAPITools.Test\Org.OpenAPITools.Test.csproj
-
- - dotnet test samples\client\petstore\csharp\generichost\net9\AllOf\src\Org.OpenAPITools.Test\Org.OpenAPITools.Test.csproj
- - dotnet test samples\client\petstore\csharp\generichost\net9\AnyOf\src\Org.OpenAPITools.Test\Org.OpenAPITools.Test.csproj
- - dotnet test samples\client\petstore\csharp\generichost\net9\AnyOfNoCompare\src\Org.OpenAPITools.Test\Org.OpenAPITools.Test.csproj
- - dotnet test samples\client\petstore\csharp\generichost\net9\FormModels\src\Org.OpenAPITools.Test\Org.OpenAPITools.Test.csproj
- # - dotnet test samples\client\petstore\csharp\generichost\net9\ManualSourceGenerationTests\ManualTests.Latest.UseSourceGeneration\ManualTests.Latest.UseSourceGeneration.csproj
- # - dotnet test samples\client\petstore\csharp\generichost\net9\ManualPetstoreTests\OpenAPIClient-generichost-manual-tests\OpenAPIClient-generichost-manual-tests.csproj
- - dotnet test samples\client\petstore\csharp\generichost\net9\NullReferenceTypes\src\Org.OpenAPITools.Test\Org.OpenAPITools.Test.csproj
- - dotnet test samples\client\petstore\csharp\generichost\net9\OneOf\src\Org.OpenAPITools.Test\Org.OpenAPITools.Test.csproj
- - dotnet test samples\client\petstore\csharp\generichost\net9\Petstore\src\Org.OpenAPITools.Test\Org.OpenAPITools.Test.csproj
- - dotnet test samples\client\petstore\csharp\generichost\net9\SourceGeneration\src\Org.OpenAPITools.Test\Org.OpenAPITools.Test.csproj
- - dotnet test samples\client\petstore\csharp\generichost\net9\UseDateTimeForDate\src\Org.OpenAPITools.Test\Org.OpenAPITools.Test.csproj
-
- - dotnet test samples\client\petstore\csharp\generichost\net8\AllOf\src\Org.OpenAPITools.Test\Org.OpenAPITools.Test.csproj
- - dotnet test samples\client\petstore\csharp\generichost\net8\AnyOf\src\Org.OpenAPITools.Test\Org.OpenAPITools.Test.csproj
- - dotnet test samples\client\petstore\csharp\generichost\net8\AnyOfNoCompare\src\Org.OpenAPITools.Test\Org.OpenAPITools.Test.csproj
- - dotnet test samples\client\petstore\csharp\generichost\net8\FormModels\src\Org.OpenAPITools.Test\Org.OpenAPITools.Test.csproj
- - dotnet test samples\client\petstore\csharp\generichost\net8\ManualSourceGenerationTests\ManualTests.Latest.UseSourceGeneration\ManualTests.Latest.UseSourceGeneration.csproj
- - dotnet test samples\client\petstore\csharp\generichost\net8\ManualPetstoreTests\OpenAPIClient-generichost-manual-tests\OpenAPIClient-generichost-manual-tests.csproj
- - dotnet test samples\client\petstore\csharp\generichost\net8\NullReferenceTypes\src\Org.OpenAPITools.Test\Org.OpenAPITools.Test.csproj
- - dotnet test samples\client\petstore\csharp\generichost\net8\OneOf\src\Org.OpenAPITools.Test\Org.OpenAPITools.Test.csproj
- - dotnet test samples\client\petstore\csharp\generichost\net8\Petstore\src\Org.OpenAPITools.Test\Org.OpenAPITools.Test.csproj
- - dotnet test samples\client\petstore\csharp\generichost\net8\SourceGeneration\src\Org.OpenAPITools.Test\Org.OpenAPITools.Test.csproj
- - dotnet test samples\client\petstore\csharp\generichost\net8\UseDateTimeForDate\src\Org.OpenAPITools.Test\Org.OpenAPITools.Test.csproj
-
- - dotnet test samples\client\petstore\csharp\generichost\standard2.0\Petstore\src\Org.OpenAPITools.Test\Org.OpenAPITools.Test.csproj
-
- - dotnet test samples\client\petstore\csharp\generichost\net4.8\AllOf\src\Org.OpenAPITools.Test\Org.OpenAPITools.Test.csproj
- - dotnet test samples\client\petstore\csharp\generichost\net4.8\AnyOf\src\Org.OpenAPITools.Test\Org.OpenAPITools.Test.csproj
- - dotnet test samples\client\petstore\csharp\generichost\net4.8\AnyOfNoCompare\src\Org.OpenAPITools.Test\Org.OpenAPITools.Test.csproj
- - dotnet test samples\client\petstore\csharp\generichost\net4.8\FormModels\src\Org.OpenAPITools.Test\Org.OpenAPITools.Test.csproj
- - dotnet test samples\client\petstore\csharp\generichost\net4.8\OneOf\src\Org.OpenAPITools.Test\Org.OpenAPITools.Test.csproj
- - dotnet test samples\client\petstore\csharp\generichost\net4.8\Petstore\src\Org.OpenAPITools.Test\Org.OpenAPITools.Test.csproj
- - dotnet test samples\client\petstore\csharp\generichost\net4.8\UseDateTimeForDate\src\Org.OpenAPITools.Test\Org.OpenAPITools.Test.csproj
-
- - dotnet test samples\client\petstore\csharp\generichost\net4.7\AllOf\src\Org.OpenAPITools.Test\Org.OpenAPITools.Test.csproj
- - dotnet test samples\client\petstore\csharp\generichost\net4.7\AnyOf\src\Org.OpenAPITools.Test\Org.OpenAPITools.Test.csproj
- - dotnet test samples\client\petstore\csharp\generichost\net4.7\AnyOfNoCompare\src\Org.OpenAPITools.Test\Org.OpenAPITools.Test.csproj
- - dotnet test samples\client\petstore\csharp\generichost\net4.7\FormModels\src\Org.OpenAPITools.Test\Org.OpenAPITools.Test.csproj
- - dotnet test samples\client\petstore\csharp\generichost\net4.7\OneOf\src\Org.OpenAPITools.Test\Org.OpenAPITools.Test.csproj
- - dotnet test samples\client\petstore\csharp\generichost\net4.7\Petstore\src\Org.OpenAPITools.Test\Org.OpenAPITools.Test.csproj
- - dotnet test samples\client\petstore\csharp\generichost\net4.7\UseDateTimeForDate\src\Org.OpenAPITools.Test\Org.OpenAPITools.Test.csproj
-
- - dotnet test samples\client\petstore\csharp\httpclient\standard2.0\Petstore\src\Org.OpenAPITools.Test\Org.OpenAPITools.Test.csproj
-
- - dotnet test samples\client\petstore\csharp\restsharp\net4.7\MultipleFrameworks\src\Org.OpenAPITools.Test\Org.OpenAPITools.Test.csproj
- - dotnet test samples\client\petstore\csharp\restsharp\net4.7\Petstore\src\Org.OpenAPITools.Test\Org.OpenAPITools.Test.csproj
- - dotnet test samples\client\petstore\csharp\restsharp\net4.8\Petstore\src\Org.OpenAPITools.Test\Org.OpenAPITools.Test.csproj
- - dotnet test samples\client\petstore\csharp\restsharp\net8\ParameterMappings\src\Org.OpenAPITools.Test\Org.OpenAPITools.Test.csproj
- - dotnet test samples\client\petstore\csharp\restsharp\net8\EnumMappings\src\Org.OpenAPITools.Test\Org.OpenAPITools.Test.csproj
- - dotnet test samples\client\petstore\csharp\restsharp\net8\Petstore\src\Org.OpenAPITools.Test\Org.OpenAPITools.Test.csproj
- - dotnet test samples\client\petstore\csharp\restsharp\net8\UseDateTimeForDate\src\Org.OpenAPITools.Test\Org.OpenAPITools.Test.csproj
- - dotnet test samples\client\petstore\csharp\restsharp\standard2.0\ConditionalSerialization\src\Org.OpenAPITools.Test\Org.OpenAPITools.Test.csproj
- - dotnet test samples\client\petstore\csharp\restsharp\standard2.0\Petstore\src\Org.OpenAPITools.Test\Org.OpenAPITools.Test.csproj
-
-### TODO: Execute all generators via powershell or other
- # generate all petstore clients
- # - .\bin\windows\run-all-petstore.cmd
- # generate all petstore clients (openapi3)
- # - .\bin\openapi3\windows\run-all-petstore.cmd
-
- # test ps petstore
- - ps: |
- cd samples\client\petstore\powershell\
- .\CIRunTest.ps1
-cache:
- - C:\maven\
- - C:\gradle\
- - C:\Users\appveyor\.m2
diff --git a/bin/configs/cpp-httplib-petstore.yaml b/bin/configs/cpp-httplib-petstore.yaml
new file mode 100644
index 000000000000..000c8967d7ed
--- /dev/null
+++ b/bin/configs/cpp-httplib-petstore.yaml
@@ -0,0 +1,9 @@
+generatorName: cpp-httplib-server
+outputDir: samples/server/petstore/cpp-httplib-server
+inputSpec: modules/openapi-generator/src/test/resources/3_0/cpp-httplib-server/petstore.yaml
+templateDir: modules/openapi-generator/src/main/resources/cpp-httplib-server
+additionalProperties:
+ apiNamespace: "petstore::openapi::api"
+ modelNamespace: "petstore::openapi::model"
+ projectName: "petStoreProject"
+ addApiImplStubs: true
diff --git a/bin/configs/csharp-httpclient-net9-nonPublicApi.yaml b/bin/configs/csharp-httpclient-net9-nonPublicApi.yaml
new file mode 100644
index 000000000000..8f561dd0026e
--- /dev/null
+++ b/bin/configs/csharp-httpclient-net9-nonPublicApi.yaml
@@ -0,0 +1,14 @@
+# for .net standard httpclient
+generatorName: csharp
+outputDir: samples/client/petstore/csharp/httpclient/net9/Petstore-nonPublicApi
+inputSpec: modules/openapi-generator/src/test/resources/3_0/petstore-addpet-only.yaml
+templateDir: modules/openapi-generator/src/main/resources/csharp
+library: httpclient
+additionalProperties:
+ packageGuid: '{321C8C3F-0156-40C1-AE42-D59761FB9B6C}'
+ useCompareNetObjects: true
+ disallowAdditionalPropertiesIfNotPresent: false
+ useOneOfDiscriminatorLookup: true
+ targetFramework: net9.0
+ equatable: true
+ nonPublicApi: true
diff --git a/bin/configs/csharp-restsharp-netstandard2.0.yaml b/bin/configs/csharp-restsharp-netstandard2.0.yaml
index c4a6d05757d3..f4b8e5502353 100644
--- a/bin/configs/csharp-restsharp-netstandard2.0.yaml
+++ b/bin/configs/csharp-restsharp-netstandard2.0.yaml
@@ -2,7 +2,7 @@
generatorName: csharp
library: restsharp
outputDir: samples/client/petstore/csharp/restsharp/standard2.0/Petstore
-inputSpec: modules/openapi-generator/src/test/resources/3_0/csharp/petstore-with-fake-endpoints-models-for-testing-with-http-signature-oneof-primitive-types.yaml
+inputSpec: modules/openapi-generator/src/test/resources/3_0/csharp/petstore-with-fake-endpoints-models-for-testing-with-http-signature-oneof-primitive-types-localhost.yaml
templateDir: modules/openapi-generator/src/main/resources/csharp
additionalProperties:
packageGuid: '{321C8C3F-0156-40C1-AE42-D59761FB9B6C}'
diff --git a/bin/configs/dart-dio-petstore-timemachine.yaml b/bin/configs/dart-dio-petstore-timemachine.yaml
new file mode 100644
index 000000000000..d3243a135312
--- /dev/null
+++ b/bin/configs/dart-dio-petstore-timemachine.yaml
@@ -0,0 +1,14 @@
+generatorName: dart-dio
+outputDir: samples/openapi3/client/petstore/dart-dio/petstore-timemachine
+inputSpec: modules/openapi-generator/src/test/resources/3_0/petstore.yaml
+templateDir: modules/openapi-generator/src/main/resources/dart/libraries/dio
+typeMappings:
+ Client: "ModelClient"
+ File: "ModelFile"
+ EnumClass: "ModelEnumClass"
+additionalProperties:
+ hideGenerationTimestamp: "true"
+ enumUnknownDefaultCase: "true"
+ dateLibrary: "timemachine"
+reservedWordsMappings:
+ class: "classField"
diff --git a/bin/configs/go-petstore-oas2.yaml b/bin/configs/go-petstore-oas2.yaml
index 18cb77a9c250..31f3436cf270 100644
--- a/bin/configs/go-petstore-oas2.yaml
+++ b/bin/configs/go-petstore-oas2.yaml
@@ -1,6 +1,6 @@
generatorName: go
outputDir: samples/client/petstore/go/go-petstore
-inputSpec: modules/openapi-generator/src/test/resources/2_0/petstore-with-fake-endpoints-models-for-testing.yaml
+inputSpec: modules/openapi-generator/src/test/resources/2_0/petstore-with-fake-endpoints-models-for-testing-localhost.yaml
templateDir: modules/openapi-generator/src/main/resources/go
additionalProperties:
packageName: petstore
diff --git a/bin/configs/go-server-optional-body.yaml b/bin/configs/go-server-optional-body.yaml
new file mode 100644
index 000000000000..4dc5cea0aa22
--- /dev/null
+++ b/bin/configs/go-server-optional-body.yaml
@@ -0,0 +1,8 @@
+generatorName: go-server
+outputDir: samples/server/others/go-server/optional-body
+inputSpec: modules/openapi-generator/src/test/resources/3_0/optional_body.yaml
+templateDir: modules/openapi-generator/src/main/resources/go-server
+additionalProperties:
+ hideGenerationTimestamp: "true"
+ packageName: petstoreserver
+ addResponseHeaders: true
diff --git a/bin/configs/java-dubbo-server.yaml b/bin/configs/java-dubbo-server.yaml
new file mode 100644
index 000000000000..1b285d67f702
--- /dev/null
+++ b/bin/configs/java-dubbo-server.yaml
@@ -0,0 +1,15 @@
+generatorName: java-dubbo
+outputDir: samples/server/petstore/java-dubbo
+inputSpec: modules/openapi-generator/src/test/resources/3_0/petstore.yaml
+templateDir: modules/openapi-generator/src/main/resources/java-dubbo
+additionalProperties:
+ hideGenerationTimestamp: "true"
+ artifactId: openapi-dubbo-server-petstore
+ basePackage: "org.openapitools.example"
+ title: "OpenAPI Petstore"
+ serviceInterface: true
+ serviceImplementation: true
+ useTags: true
+ dubboVersion: "3.2.18"
+ javaVersion: "17"
+ registryAddress: "zookeeper://127.0.0.1:2181"
diff --git a/bin/configs/jaxrs-cxf-client-swagger2.yaml b/bin/configs/jaxrs-cxf-client-swagger2.yaml
new file mode 100644
index 000000000000..7efef0f734a9
--- /dev/null
+++ b/bin/configs/jaxrs-cxf-client-swagger2.yaml
@@ -0,0 +1,8 @@
+generatorName: jaxrs-cxf-client
+outputDir: samples/client/petstore/jaxrs-cxf-client-swagger2
+inputSpec: modules/openapi-generator/src/test/resources/3_0/petstore.yaml
+templateDir: modules/openapi-generator/src/main/resources/JavaJaxRS/cxf
+additionalProperties:
+ artifactId: jaxrs-cxf-petstore-swagger2
+ documentationProvider: swagger2
+ annotationLibrary: swagger2
diff --git a/bin/configs/jaxrs-spec-swagger-annotations.yaml b/bin/configs/jaxrs-spec-swagger-annotations.yaml
new file mode 100644
index 000000000000..32b94175c667
--- /dev/null
+++ b/bin/configs/jaxrs-spec-swagger-annotations.yaml
@@ -0,0 +1,11 @@
+generatorName: jaxrs-spec
+outputDir: samples/server/petstore/jaxrs-spec-swagger-annotations
+inputSpec: modules/openapi-generator/src/test/resources/3_0/jaxrs-spec/petstore-with-fake-endpoints-models-for-testing.yaml
+templateDir: modules/openapi-generator/src/main/resources/JavaJaxRS/spec
+additionalProperties:
+ artifactId: jaxrs-spec-petstore-server
+ serializableModel: "true"
+ hideGenerationTimestamp: "true"
+ implicitHeadersRegex: (api_key|enum_header_string)
+ generateBuilders: "true"
+ useSwaggerAnnotations: "true"
diff --git a/bin/configs/jaxrs-spec-swagger-v3-annotations-jakarta.yaml b/bin/configs/jaxrs-spec-swagger-v3-annotations-jakarta.yaml
new file mode 100644
index 000000000000..45176fa3384f
--- /dev/null
+++ b/bin/configs/jaxrs-spec-swagger-v3-annotations-jakarta.yaml
@@ -0,0 +1,12 @@
+generatorName: jaxrs-spec
+outputDir: samples/server/petstore/jaxrs-spec-swagger-v3-annotations-jakarta
+inputSpec: modules/openapi-generator/src/test/resources/3_0/jaxrs-spec/petstore-with-fake-endpoints-models-for-testing.yaml
+templateDir: modules/openapi-generator/src/main/resources/JavaJaxRS/spec
+additionalProperties:
+ artifactId: jaxrs-spec-petstore-server-jakarta-swagger-v3
+ serializableModel: "true"
+ hideGenerationTimestamp: "true"
+ implicitHeadersRegex: (api_key|enum_header_string)
+ generateBuilders: "true"
+ useSwaggerV3Annotations: "true"
+ useJakartaEe: "true"
diff --git a/bin/configs/jaxrs-spec-swagger-v3-annotations.yaml b/bin/configs/jaxrs-spec-swagger-v3-annotations.yaml
new file mode 100644
index 000000000000..903753fa5e2f
--- /dev/null
+++ b/bin/configs/jaxrs-spec-swagger-v3-annotations.yaml
@@ -0,0 +1,11 @@
+generatorName: jaxrs-spec
+outputDir: samples/server/petstore/jaxrs-spec-swagger-v3-annotations
+inputSpec: modules/openapi-generator/src/test/resources/3_0/jaxrs-spec/petstore-with-fake-endpoints-models-for-testing.yaml
+templateDir: modules/openapi-generator/src/main/resources/JavaJaxRS/spec
+additionalProperties:
+ artifactId: jaxrs-spec-petstore-server
+ serializableModel: "true"
+ hideGenerationTimestamp: "true"
+ implicitHeadersRegex: (api_key|enum_header_string)
+ generateBuilders: "true"
+ useSwaggerV3Annotations: "true"
diff --git a/bin/configs/jaxrs-spec-withxml.yaml b/bin/configs/jaxrs-spec-withxml.yaml
new file mode 100644
index 000000000000..f893491fc9fb
--- /dev/null
+++ b/bin/configs/jaxrs-spec-withxml.yaml
@@ -0,0 +1,10 @@
+generatorName: jaxrs-spec
+outputDir: samples/server/petstore/jaxrs-spec-withxml/
+inputSpec: modules/openapi-generator/src/test/resources/3_0/jaxrs-spec/petstore-with-fake-endpoints-models-for-testing.yaml
+templateDir: modules/openapi-generator/src/main/resources/JavaJaxRS/spec
+additionalProperties:
+ artifactId: jaxrs-spec-withxml-petstore-server
+ serializableModel: "true"
+ hideGenerationTimestamp: "true"
+ generateBuilders: "true"
+ withXml: true
diff --git a/bin/configs/kotlin-array-integer-enum.yaml b/bin/configs/kotlin-array-integer-enum.yaml
new file mode 100644
index 000000000000..8b802b8d8298
--- /dev/null
+++ b/bin/configs/kotlin-array-integer-enum.yaml
@@ -0,0 +1,8 @@
+generatorName: kotlin
+outputDir: samples/client/petstore/kotlin-array-integer-enum
+inputSpec: modules/openapi-generator/src/test/resources/3_0/kotlin/issue15204-int-array-enum.yaml
+templateDir: modules/openapi-generator/src/main/resources/kotlin-client
+additionalProperties:
+ artifactId: kotlin-array-integer-enum
+ serializableModel: "true"
+ dateLibrary: java8
diff --git a/bin/configs/kotlin-jvm-ktor-gson.yaml b/bin/configs/kotlin-jvm-ktor-gson.yaml
index 6b8bd62f644c..4a122905f6c4 100644
--- a/bin/configs/kotlin-jvm-ktor-gson.yaml
+++ b/bin/configs/kotlin-jvm-ktor-gson.yaml
@@ -1,7 +1,7 @@
generatorName: kotlin
outputDir: samples/client/petstore/kotlin-jvm-ktor-gson
library: jvm-ktor
-inputSpec: modules/openapi-generator/src/test/resources/2_0/petstore.yaml
+inputSpec: modules/openapi-generator/src/test/resources/3_0/kotlin/petstore.yaml
templateDir: modules/openapi-generator/src/main/resources/kotlin-client
additionalProperties:
artifactId: kotlin-petstore-jvm-ktor-gson
diff --git a/bin/configs/kotlin-spring-boot-additionalproperties.yaml b/bin/configs/kotlin-spring-boot-additionalproperties.yaml
new file mode 100644
index 000000000000..3c3275fce2fa
--- /dev/null
+++ b/bin/configs/kotlin-spring-boot-additionalproperties.yaml
@@ -0,0 +1,14 @@
+generatorName: kotlin-spring
+outputDir: samples/server/petstore/kotlin-springboot-additionalproperties
+library: spring-boot
+inputSpec: samples/server/petstore/kotlin-springboot-additionalproperties/src/main/resources/openapi.yaml
+templateDir: modules/openapi-generator/src/main/resources/kotlin-spring
+additionalProperties:
+ documentationProvider: none
+ annotationLibrary: none
+ useSwaggerUI: "false"
+ serviceImplementation: "true"
+ serializableModel: "true"
+ beanValidations: "true"
+ useSpringBoot3: "true"
+ requestMappingMode: api_interface
diff --git a/bin/configs/kotlin-spring-boot-x-kotlin-implements.yaml b/bin/configs/kotlin-spring-boot-x-kotlin-implements.yaml
new file mode 100644
index 000000000000..c4068770d55d
--- /dev/null
+++ b/bin/configs/kotlin-spring-boot-x-kotlin-implements.yaml
@@ -0,0 +1,14 @@
+generatorName: kotlin-spring
+outputDir: samples/server/petstore/kotlin-springboot-x-kotlin-implements
+library: spring-boot
+inputSpec: modules/openapi-generator/src/test/resources/3_0/kotlin/petstore-with-x-kotlin-implements.yaml
+templateDir: modules/openapi-generator/src/main/resources/kotlin-spring
+additionalProperties:
+ documentationProvider: none
+ annotationLibrary: none
+ useSwaggerUI: "false"
+ serviceImplementation: "false"
+ skipDefaultInterface: "true"
+ interfaceOnly: "true"
+ serializableModel: "true"
+ beanValidations: "true"
diff --git a/bin/configs/python-httpx.yaml b/bin/configs/python-httpx.yaml
new file mode 100644
index 000000000000..afc0b04ee9c0
--- /dev/null
+++ b/bin/configs/python-httpx.yaml
@@ -0,0 +1,15 @@
+generatorName: python
+outputDir: samples/openapi3/client/petstore/python-httpx
+inputSpec: modules/openapi-generator/src/test/resources/3_0/python/petstore-with-fake-endpoints-models-for-testing.yaml
+templateDir: modules/openapi-generator/src/main/resources/python
+library: httpx
+additionalProperties:
+ packageName: petstore_api
+ mapNumberTo: float
+ poetry1: false
+nameMappings:
+ _type: underscore_type
+ type_: type_with_underscore
+modelNameMappings:
+ # The OpenAPI spec ApiResponse conflicts with the internal ApiResponse
+ ApiResponse: ModelApiResponse
diff --git a/bin/configs/python-lazyImports.yaml b/bin/configs/python-lazyImports.yaml
new file mode 100644
index 000000000000..88c0b631cafe
--- /dev/null
+++ b/bin/configs/python-lazyImports.yaml
@@ -0,0 +1,18 @@
+generatorName: python
+outputDir: samples/openapi3/client/petstore/python-lazyImports
+inputSpec: modules/openapi-generator/src/test/resources/3_0/python/petstore-with-fake-endpoints-models-for-testing.yaml
+templateDir: modules/openapi-generator/src/main/resources/python
+additionalProperties:
+ packageName: petstore_api
+ useOneOfDiscriminatorLookup: "true"
+ disallowAdditionalPropertiesIfNotPresent: false
+ mapNumberTo: StrictFloat
+ lazyImports: 'true'
+nameMappings:
+ _type: underscore_type
+ type_: type_with_underscore
+modelNameMappings:
+ # The OpenAPI spec ApiResponse conflicts with the internal ApiResponse
+ ApiResponse: ModelApiResponse
+openapiNormalizer:
+ SIMPLIFY_ONEOF_ANYOF_ENUM: false
diff --git a/bin/configs/ruby-faraday.yaml b/bin/configs/ruby-faraday.yaml
index b289ae977f48..7e7731d61461 100644
--- a/bin/configs/ruby-faraday.yaml
+++ b/bin/configs/ruby-faraday.yaml
@@ -1,7 +1,7 @@
generatorName: ruby
outputDir: samples/client/petstore/ruby-faraday
library: faraday
-inputSpec: modules/openapi-generator/src/test/resources/3_0/petstore-with-fake-endpoints-models-for-testing.yaml
+inputSpec: modules/openapi-generator/src/test/resources/3_0/ruby/petstore-with-fake-endpoints-models-for-testing.yaml
templateDir: modules/openapi-generator/src/main/resources/ruby-client
additionalProperties:
gemVersion: 1.0.0
diff --git a/bin/configs/rust-reqwest-enum-query-params.yaml b/bin/configs/rust-reqwest-enum-query-params.yaml
new file mode 100644
index 000000000000..db7adb03233f
--- /dev/null
+++ b/bin/configs/rust-reqwest-enum-query-params.yaml
@@ -0,0 +1,8 @@
+generatorName: rust
+outputDir: samples/client/others/rust/reqwest/enum-query-params
+library: reqwest
+inputSpec: modules/openapi-generator/src/test/resources/3_0/rust/enum-query-params.yaml
+templateDir: modules/openapi-generator/src/main/resources/rust
+additionalProperties:
+ supportAsync: true
+ packageName: enum-query-params-reqwest
diff --git a/bin/configs/spring-boot-oneof-interface.yaml b/bin/configs/spring-boot-oneof-interface.yaml
new file mode 100644
index 000000000000..a66a2c4bfc97
--- /dev/null
+++ b/bin/configs/spring-boot-oneof-interface.yaml
@@ -0,0 +1,12 @@
+generatorName: spring
+outputDir: samples/openapi3/server/petstore/spring-boot-oneof-interface
+inputSpec: modules/openapi-generator/src/test/resources/3_0/oneof_polymorphism_and_inheritance.yaml
+templateDir: modules/openapi-generator/src/main/resources/JavaSpring
+additionalProperties:
+ groupId: org.openapitools.openapi3
+ documentationProvider: springdoc
+ artifactId: springboot-oneof
+ snapshotVersion: "true"
+ hideGenerationTimestamp: "true"
+ useOneOfInterfaces: "true"
+ useDeductionForOneOfInterfaces: "true"
diff --git a/bin/configs/typescript-angular-v19-provided-in-root.yaml b/bin/configs/typescript-angular-v19-provided-in-root.yaml
new file mode 100644
index 000000000000..f4f2fb24489c
--- /dev/null
+++ b/bin/configs/typescript-angular-v19-provided-in-root.yaml
@@ -0,0 +1,9 @@
+generatorName: typescript-angular
+outputDir: samples/client/petstore/typescript-angular-v19-provided-in-root/builds/default
+inputSpec: modules/openapi-generator/src/test/resources/3_0/petstore.yaml
+templateDir: modules/openapi-generator/src/main/resources/typescript-angular
+additionalProperties:
+ ngVersion: 19.0.0
+ supportsES6: true
+enumNameMappings:
+ delivered: SHIPPED
diff --git a/bin/configs/typescript-angular-v20-provided-in-root.yaml b/bin/configs/typescript-angular-v20-provided-in-root.yaml
new file mode 100644
index 000000000000..d19d5778f695
--- /dev/null
+++ b/bin/configs/typescript-angular-v20-provided-in-root.yaml
@@ -0,0 +1,9 @@
+generatorName: typescript-angular
+outputDir: samples/client/petstore/typescript-angular-v20-provided-in-root/builds/default
+inputSpec: modules/openapi-generator/src/test/resources/3_0/petstore.yaml
+templateDir: modules/openapi-generator/src/main/resources/typescript-angular
+additionalProperties:
+ ngVersion: 20.0.0
+ supportsES6: true
+enumNameMappings:
+ delivered: SHIPPED
diff --git a/bin/configs/typescript-fetch-infinite-recursion-issue.yaml b/bin/configs/typescript-fetch-infinite-recursion-issue.yaml
new file mode 100644
index 000000000000..d8882b00031b
--- /dev/null
+++ b/bin/configs/typescript-fetch-infinite-recursion-issue.yaml
@@ -0,0 +1,7 @@
+generatorName: typescript-fetch
+outputDir: samples/client/others/typescript-fetch/infinite-recursion-issue
+inputSpec: modules/openapi-generator/src/test/resources/3_0/typescript-fetch/infinite-recursion-issue.yaml
+templateDir: modules/openapi-generator/src/main/resources/typescript-fetch
+additionalProperties:
+ enumPropertyNaming: "original"
+ enumUnknownDefaultCase: true
diff --git a/bin/configs/unmaintained/scala-lagom-server.yaml b/bin/configs/unmaintained/scala-lagom-server.yaml
deleted file mode 100644
index 8aabf4b0fd08..000000000000
--- a/bin/configs/unmaintained/scala-lagom-server.yaml
+++ /dev/null
@@ -1,6 +0,0 @@
-systemProperties:
- skipFormModel: "true"
-generatorName: scala-lagom-server
-outputDir: samples/server/petstore/scala-lagom-server
-inputSpec: modules/openapi-generator/src/test/resources/3_0/petstore.yaml
-templateDir: modules/openapi-generator/src/main/resources/scala-lagom-server
diff --git a/bin/utils/dart-keywords/README.md b/bin/utils/dart-keywords/README.md
index 2d14a81b61d7..8b414c77f411 100644
--- a/bin/utils/dart-keywords/README.md
+++ b/bin/utils/dart-keywords/README.md
@@ -5,11 +5,11 @@ Running `./save_dart_keywords.sh` from this directory will generate `dart-keywor
## When should the keywords be generated?
-`save_dart_keywords.sh` should be run when a new version of Dart is release to update the keywords file.
+`save_dart_keywords.sh` should be run when a new version of Dart is released to update the keywords file.
The last Dart version that was used to generate the keywords can be found in `dart-version.txt`.
-## What does the shellscript do?
+## What does the shell script do?
1. run the dart app
- `dart run save-dart-keywords.dart`
diff --git a/bin/utils/test_file_list.yaml b/bin/utils/test_file_list.yaml
index 1d0fb391de09..fbabb57e270e 100644
--- a/bin/utils/test_file_list.yaml
+++ b/bin/utils/test_file_list.yaml
@@ -31,10 +31,10 @@
sha256: 24c6a39a9d7327d397dc038c368a19c84f14ed96a69fe28d53719b3eaf0a725c
- filename: "samples/client/petstore/java/jersey3/src/test/java/org/openapitools/client/api/PetApiTest.java"
sha256: 5e9f471d34310f94895751bb96cc79583376f043593c3a387c82077c70f8102f
-- filename: "samples/client/petstore/java/jersey3/src/test/java/org/openapitools/client/model/MammalTest.java"
- sha256: 67a9e63e13ebddac21cb236aa015edce30f5d3bd8d6adcf50044cad00d48c45e
-- filename: "samples/client/petstore/java/jersey3/src/test/java/org/openapitools/client/model/ZebraTest.java"
- sha256: 15eeb6d8a9a79d0f1930b861540d9c5780d6c49ea4fdb68269ac3e7ec481e142
+- filename: "samples/client/petstore/java/jersey3/src/test/java/org/openapitools/client/MammalTest.java"
+ sha256: a09c120b694788b12f8d73cc0dd307e509ee1744b2ff45c5711b1186c419f915
+- filename: "samples/client/petstore/java/jersey3/src/test/java/org/openapitools/client/ZebraTest.java"
+ sha256: 15e509d8cb8e9b050c6418cfbf8a5dced9acc97cf29e5727da9f907c52d11f1e
- filename: "samples/client/petstore/java/okhttp-gson-3.1/src/test/java/org/openapitools/client/api/PetApiTest.java"
sha256: d8f7fff724f81e666daf115cc25f8347e1fda4e861aa30df0dae3fa50c91404c
- filename: "samples/client/petstore/java/okhttp-gson-dynamicOperations/src/test/java/org/openapitools/client/api/PetApiTest.java"
@@ -59,6 +59,6 @@
sha256: 45cdaba3d2adc212cd4f0184ad475419a95e2326254c2ef84175e210c922b2f3
# rust axum test files
- filename: "samples/server/petstore/rust-axum/output/rust-axum-oneof/tests/oneof_with_discriminator.rs"
- sha256: 2d4f5a069fdcb3057bb078d5e75b3de63cd477b97725e457079df24bd2c30600
+ sha256: b2093528aac971193f2863a70f46eea45cf8bda79120b133a614599e80d8b46d
- filename: "samples/server/petstore/rust-axum/output/openapi-v3/tests/oneof_untagged.rs"
- sha256: e72fbf81a9849dc7abb7e2169f2fc355c8b1cf991c0e2ffc083126abd9e966e7
+ sha256: 1d3fb01f65e98290b1d3eece28014c7d3e3f2fdf18e7110249d3c591cc4642ab
diff --git a/docs/customization.md b/docs/customization.md
index acb45936fd21..ffff0188e96d 100644
--- a/docs/customization.md
+++ b/docs/customization.md
@@ -538,6 +538,7 @@ OpenAPI Normalizer transforms the input OpenAPI doc/spec (which may not perfectl
- SIMPLIFY_ONEOF_ANYOF
- SIMPLIFY_BOOLEAN_ENUM
+- REFACTOR_ALLOF_WITH_PROPERTIES_ONLY
(One can use `DISABLE_ALL=true` to disable all the rules)
@@ -643,9 +644,16 @@ Example:
java -jar modules/openapi-generator-cli/target/openapi-generator-cli.jar generate -g java -i modules/openapi-generator/src/test/resources/3_0/required-properties.yaml -o /tmp/java-okhttp/ --openapi-normalizer NORMALIZER_CLASS=org.openapitools.codegen.OpenAPINormalizerTest$RemoveRequiredNormalizer
```
+- `REMOVE_PROPERTIES_FROM_TYPE_OTHER_THAN_OBJECT`: When set to true, remove the "properties" of a schema with type other than "object".
+
+Example:
+```
+java -jar modules/openapi-generator-cli/target/openapi-generator-cli.jar generate -g java -i modules/openapi-generator/src/test/resources/3_0/required-properties.yaml -o /tmp/java-okhttp/ --openapi-normalizer REMOVE_PROPERTIES_FROM_TYPE_OTHER_THAN_OBJECT=true
+```
+
- `FILTER`
-The `FILTER` parameter allows selective inclusion of API operations based on specific criteria. It applies the `x-internal: true` property to operations that do **not** match the specified values, preventing them from being generated.
+The `FILTER` parameter allows selective inclusion of API operations based on specific criteria. It applies the `x-internal: true` property to operations that do **not** match the specified values, preventing them from being generated. Multiple filters can be separated by a semicolon.
### Available Filters
@@ -658,6 +666,9 @@ The `FILTER` parameter allows selective inclusion of API operations based on spe
- **`tag`**
When set to `tag:person|basic`, operations **not** tagged with `person` or `basic` will be marked as internal (`x-internal: true`), and will not be generated.
+- **`path`**
+ When set to `path:/v1|/v2`, operations on paths **not** starting with `/v1` or with `/v2` will be marked as internal (`x-internal: true`), and will not be generated.
+
### Example Usage
```sh
@@ -665,7 +676,7 @@ java -jar modules/openapi-generator-cli/target/openapi-generator-cli.jar generat
-g java \
-i modules/openapi-generator/src/test/resources/3_0/petstore.yaml \
-o /tmp/java-okhttp/ \
- --openapi-normalizer FILTER="operationId:addPet|getPetById"
+ --openapi-normalizer FILTER="operationId:addPet|getPetById ; tag:store"
```
- `SET_CONTAINER_TO_NULLABLE`: When set to `array|set|map` (or just `array`) for example, it will set `nullable` in array, set and map to true.
diff --git a/docs/debugging.md b/docs/debugging.md
index 76ad96de1867..da8904132daa 100644
--- a/docs/debugging.md
+++ b/docs/debugging.md
@@ -5,7 +5,7 @@ title: Debugging
## Generation
-As a user there may be times when generated outputs don't match your expectations it's unclear why. The CLI supports a `--dry-run` option which may be used to inspect the anticipated file operations without making changes to the file system.
+As a user there may be times when generated outputs don't match your expectations and it's unclear why. The CLI supports a `--dry-run` option which may be used to inspect the anticipated file operations without making changes to the file system.
Suppose you generate using the `--minimal-update` option, and you notice on subsequent generations of a client that no files have changed. This is by design.
diff --git a/docs/generators.md b/docs/generators.md
index da5ce3851550..436db03d94b2 100644
--- a/docs/generators.md
+++ b/docs/generators.md
@@ -3,6 +3,7 @@ id: generators
title: Generators List
---
+[main] INFO o.o.c.l.PythonFastAPIServerCodegen - Skipping sorting of path operations, order matters, let the developer decide via their specification file.
The following generators are available:
## CLIENT generators
@@ -12,7 +13,6 @@ The following generators are available:
* [bash](generators/bash.md)
* [c](generators/c.md)
* [clojure](generators/clojure.md)
-* [cpp-oatpp-client](generators/cpp-oatpp-client.md)
* [cpp-qt-client](generators/cpp-qt-client.md)
* [cpp-restsdk](generators/cpp-restsdk.md)
* [cpp-tiny (beta)](generators/cpp-tiny.md)
@@ -65,11 +65,10 @@ The following generators are available:
* [scala-pekko](generators/scala-pekko.md)
* [scala-sttp](generators/scala-sttp.md)
* [scala-sttp4 (beta)](generators/scala-sttp4.md)
-* [scala-sttp4-jsoniter (beta)](generators/scala-sttp4-jsoniter.md)
* [scalaz](generators/scalaz.md)
* [swift-combine](generators/swift-combine.md)
* [swift5](generators/swift5.md)
-* [swift6](generators/swift6.md)
+* [swift6 (beta)](generators/swift6.md)
* [typescript (experimental)](generators/typescript.md)
* [typescript-angular](generators/typescript-angular.md)
* [typescript-aurelia](generators/typescript-aurelia.md)
@@ -106,6 +105,7 @@ The following generators are available:
* [haskell](generators/haskell.md)
* [haskell-yesod (beta)](generators/haskell-yesod.md)
* [java-camel](generators/java-camel.md)
+* [java-dubbo (beta)](generators/java-dubbo.md)
* [java-helidon-server (beta)](generators/java-helidon-server.md)
* [java-inflector](generators/java-inflector.md)
* [java-micronaut-server (beta)](generators/java-micronaut-server.md)
@@ -150,11 +150,10 @@ The following generators are available:
* [scala-cask](generators/scala-cask.md)
* [scala-finch](generators/scala-finch.md)
* [scala-http4s-server](generators/scala-http4s-server.md)
-* [scala-lagom-server](generators/scala-lagom-server.md)
+* [scala-lagom-server-deprecated (deprecated)](generators/scala-lagom-server-deprecated.md)
* [scala-play-server](generators/scala-play-server.md)
* [scalatra](generators/scalatra.md)
* [spring](generators/spring.md)
-* [typescript-nestjs-server (beta)](generators/typescript-nestjs-server.md)
## DOCUMENTATION generators
diff --git a/docs/generators/cpp-httplib-server.md b/docs/generators/cpp-httplib-server.md
new file mode 100644
index 000000000000..7a7ccfbf9913
--- /dev/null
+++ b/docs/generators/cpp-httplib-server.md
@@ -0,0 +1,545 @@
+---
+title: Documentation for the cpp-httplib-server Generator
+---
+
+## METADATA
+
+| Property | Value | Notes |
+| -------- | ----- | ----- |
+| generator name | cpp-httplib-server | pass this to the generate command after -g |
+| generator stability | STABLE | |
+| generator type | SERVER | |
+| generator language | C++ | |
+| generator default templating engine | mustache | |
+| helpTxt | Generates a C++ server using the httplib library. | |
+
+## OVERVIEW
+
+The cpp-httplib-server generator creates a modern C++17/20 server implementation using the [httplib](https://github.com/yhirose/cpp-httplib) library. This generator produces:
+
+- **Type-safe API handlers** with std::variant-based response types
+- **Model classes** with JSON serialization/deserialization using nlohmann::json
+- **CMake build configuration** for easy compilation
+- **Automatic error handling** with proper HTTP status codes
+- **Namespace organization** for clean code structure
+
+### Key Features
+
+- **Modern C++ Standards**: Uses C++17+ features like std::variant, std::optional
+- **Type Safety**: Compile-time type checking for request/response handling
+- **JSON Integration**: Built-in JSON serialization with nlohmann::json
+- **Error Handling**: Automatic HTTP error response generation
+- **Lightweight**: Uses httplib for minimal dependencies
+- **Cross-platform**: Works on Windows, Linux, and macOS
+
+## GENERATED CODE STRUCTURE
+
+```
+generated/
+├── CMakeLists.txt # Build configuration
+├── README.md # Project documentation
+├── api/ # API handler classes
+│ ├── PetApi.h # API header with virtual methods
+│ └── PetApi.cpp # Route registration and request handling
+└── model/ # Data model classes
+ ├── Pet.h # Model header with JSON methods
+ └── Pet.cpp # Model implementation
+```
+
+### Generated API Handler Features
+- **Type aliases**: Only generated for operations with response schemas
+- **Virtual methods**: Return variants for schema-based operations, void for others
+- **Route registration**: Automatic HTTP method and path binding
+- **Exception handling**: Built-in JSON parsing and error response generation
+
+## CONFIG OPTIONS
+
+These options may be applied as additional-properties (cli) or configOptions (plugins). Refer to [configuration docs](https://openapi-generator.tech/docs/configuration) for more details.
+
+| Option | Description | Values | Default |
+| ------ | ----------- | ------ | ------- |
+| projectName | Name of the generated C++ project | string | cpp-httplib-server |
+| modelNamespace | Namespace for model classes | string | model |
+| apiNamespace | Namespace for API classes | string | api |
+| enumNamespace | Namespace for enum classes | string | enum |
+| licenseHeader | Custom license header for generated files | string | OpenAPI Generator default |
+| stripPathFromClassName | Enable path-based class name generation | boolean | false |
+
+## TYPE MAPPINGS
+
+The generator maps OpenAPI types to modern C++ types:
+
+| OpenAPI Type | C++ Type | Notes |
+| ------------ | -------- | ----- |
+| integer | int | 32-bit signed integer |
+| long | long | 64-bit signed integer |
+| float | float | 32-bit floating point |
+| double | double | 64-bit floating point |
+| number | double | Default numeric type |
+| boolean | bool | C++ boolean |
+| string | std::string | Standard string |
+| byte | unsigned char | Single byte |
+| binary | std::string | Binary data as string |
+| date | std::string | ISO 8601 date string |
+| date-time | std::string | ISO 8601 datetime string |
+| password | std::string | Password field |
+| object | nlohmann::json | Generic JSON object |
+| array | std::vector\ | Dynamic array |
+| file | std::string | File path or content |
+
+## ADVANCED TYPE FEATURES
+
+### Nullable Types
+Nullable properties are automatically wrapped in `std::optional`:
+```cpp
+std::optional optionalField;
+```
+
+### Response Types
+Each API endpoint generates a type-safe response based on the OpenAPI schema:
+
+**Operations with response schemas:**
+```cpp
+using PetResponse = std::variant<
+ model::Pet, // 200 success (custom model with schema)
+ std::string // 400 bad request (primitive type with schema)
+>;
+```
+
+**Operations without response schemas:**
+```cpp
+// No response type alias generated - handler returns void
+virtual void handleDeleteForPet(const model::DeletePetRequest& request) = 0;
+```
+
+### Container Types
+- **Arrays**: `std::vector`
+- **Maps**: `std::map`
+- **oneOf**: `std::variant`
+- **anyOf**: `std::any` (for flexible types)
+
+## NAMESPACE ORGANIZATION
+
+The generator creates a clean namespace hierarchy:
+
+```cpp
+namespace model {
+ class Pet { /* ... */ };
+ class User { /* ... */ };
+}
+
+namespace api {
+ class PetApi { /* ... */ };
+ class UserApi { /* ... */ };
+}
+```
+
+## ERROR HANDLING INNOVATIONS
+
+### Schema-Based Response Generation
+The generator only includes responses that have defined schemas in the OpenAPI specification:
+
+- **With custom schema**: Uses the specific model type (e.g., `model::ErrorResponse`)
+- **With primitive schema**: Uses the primitive C++ type (e.g., `std::string`, `int`)
+- **Without schema**: No response type generated - handler returns `void`
+
+This approach ensures:
+- **Type Safety**: Only meaningful data types are included in variants
+- **Simplicity**: No artificial wrapper types for schema-less responses
+- **Clarity**: Handlers only deal with actual response data structures defined in the API
+
+### Response Handler Generation
+- **Operations with schemas**: Generate `std::variant` return types and handler methods
+- **Operations without schemas**: Generate `void` handler methods with automatic status code handling
+- **Mixed operations**: Only schema-defined responses appear in the variant
+
+### Automatic Exception Handling
+Generated route handlers include comprehensive exception handling:
+- JSON parse errors → 400 Bad Request
+- General exceptions → 500 Internal Server Error
+- Custom error responses based on OpenAPI spec
+
+### Handler Method Patterns
+
+**Variant-based handlers** (operations with response schemas):
+```cpp
+PetResponse handleGetForPet(const model::GetPetRequest& request) override {
+ // Return success type or error types from the variant
+ return model::Pet{}; // or return std::string{"error message"};
+}
+```
+
+**Void handlers** (operations without response schemas):
+```cpp
+void handleDeleteForPet(const model::DeletePetRequest& request) override {
+ // No response schemas defined - HTTP status handled automatically
+ // Delete operation logic here
+ deletePetFromDatabase(request.getPetId());
+}
+```
+
+## CUSTOM MODIFICATIONS
+
+### Path-Based Class Naming
+When `stripPathFromClassName=true`, the generator intelligently extracts class names from API paths:
+
+- `/api/v1/pets/{id}` → `PetsApi`, `handleGetForPets()`
+- `/users/profile` → `ProfileApi`, `handlePostForProfile()`
+
+### String Conversion Enhancements
+The generator includes robust string conversion utilities:
+- Handles camelCase, PascalCase, snake_case
+- Splits on multiple delimiters: `/`, `_`, `-`, spaces, camelCase boundaries
+- Sanitizes invalid characters for C++ identifiers
+
+### Model Preprocessing
+Automatic schema title generation for better class names:
+- Inline request schemas: `{operationId}Request`
+- Inline response schemas: `{operationId}Response{statusCode}`
+- Nested object properties: `{parentName}_{propertyName}`
+
+## IMPORT MAPPING
+
+Standard C++ library includes are automatically generated:
+
+| C++ Type | Include |
+| -------- | ------- |
+| std::string | #include \ |
+| std::vector | #include \ |
+| std::map | #include \ |
+| std::optional | #include \ |
+| std::variant | #include \ |
+| nlohmann::json | (external dependency) |
+
+## INSTANTIATION TYPES
+
+| Type/Alias | Instantiated By |
+| ---------- | --------------- |
+| ResponseType | std::variant\ (only when schemas exist) |
+| ModelType | Generated C++ class with JSON methods |
+| HandlerType | Virtual function returning ResponseType or void |
+
+**Note**: Response type aliases are only generated for operations that have at least one response with a schema. Operations without response schemas generate void handler methods.
+
+## LANGUAGE PRIMITIVES
+
+
+
bool
+
char
+
double
+
float
+
int
+
long
+
size_t
+
std::any
+
std::deque
+
std::list
+
std::map
+
std::optional
+
std::pair
+
std::queue
+
std::set
+
std::stack
+
std::string
+
std::tuple
+
std::unordered_map
+
std::unordered_set
+
std::variant
+
std::vector
+
unsigned char
+
unsigned int
+
unsigned long
+
void
+
+
+## RESERVED WORDS
+
+
+
alignas
+
alignof
+
and
+
and_eq
+
asm
+
auto
+
bitand
+
bitor
+
bool
+
break
+
case
+
catch
+
char
+
char16_t
+
char32_t
+
class
+
compl
+
concept
+
const
+
const_cast
+
constexpr
+
continue
+
decltype
+
default
+
delete
+
do
+
double
+
dynamic_cast
+
else
+
enum
+
explicit
+
export
+
extern
+
false
+
float
+
for
+
friend
+
goto
+
if
+
inline
+
int
+
linux
+
long
+
mutable
+
namespace
+
new
+
noexcept
+
not
+
not_eq
+
nullptr
+
operator
+
or
+
or_eq
+
private
+
protected
+
public
+
register
+
reinterpret_cast
+
requires
+
return
+
short
+
signed
+
sizeof
+
static
+
static_assert
+
static_cast
+
struct
+
switch
+
template
+
this
+
thread_local
+
throw
+
true
+
try
+
typedef
+
typeid
+
typename
+
union
+
unsigned
+
using
+
virtual
+
void
+
volatile
+
wchar_t
+
while
+
xor
+
xor_eq
+
+
+## USAGE EXAMPLE
+
+### 1. Generate Server Code
+```bash
+openapi-generator generate \
+ -i petstore.yaml \
+ -g cpp-httplib-server \
+ -o ./generated \
+ --additional-properties=projectName=PetStore,modelNamespace=model,apiNamespace=api
+```
+
+### 2. Implement Handler
+```cpp
+#include "api/PetApi.h"
+
+class PetApiImpl : public api::PetApi {
+public:
+ // Handler for operation with response schemas (variant return type)
+ PetResponse handleGetForPet(const model::GetPetRequest& request) override {
+ try {
+ model::Pet pet;
+ pet.setId(request.getPetId());
+ pet.setName("Fluffy");
+ return pet; // 200 OK with Pet model
+ } catch (const std::invalid_argument& e) {
+ return std::string("Invalid pet ID"); // 400 with string schema
+ }
+ }
+
+ // Handler for operation without response schemas (void return type)
+ void handleDeleteForPet(const model::DeletePetRequest& request) override {
+ // Delete the pet from database - no response schema defined
+ deletePetFromDatabase(request.getPetId());
+ // HTTP status handled automatically by framework
+ }
+};
+```
+
+### 3. Start Server
+```cpp
+#include
+#include "api/PetApi.h"
+
+int main() {
+ httplib::Server server;
+ PetApiImpl petApi;
+
+ petApi.RegisterRoutes(server);
+
+ server.listen("localhost", 8080);
+ return 0;
+}
+```
+
+## DEPENDENCIES
+
+### Required
+- **C++17 or later**: For std::variant, std::optional
+- **nlohmann/json**: For JSON serialization
+- **httplib**: For HTTP server functionality
+
+### CMake Integration
+The generated CMakeLists.txt handles dependency management:
+```cmake
+find_package(nlohmann_json REQUIRED)
+find_package(httplib REQUIRED)
+
+target_link_libraries(${PROJECT_NAME}
+ nlohmann_json::nlohmann_json
+ httplib::httplib
+)
+```
+
+## FEATURE SET
+
+### Client Modification Feature
+| Name | Supported | Defined By |
+| ---- | --------- | ---------- |
+|BasePath|✗|ToolingExtension
+|Authorizations|✗|ToolingExtension
+|UserAgent|✗|ToolingExtension
+|MockServer|✗|ToolingExtension
+
+### Data Type Feature
+| Name | Supported | Defined By |
+| ---- | --------- | ---------- |
+|Custom|✓|OAS2,OAS3
+|Int32|✓|OAS2,OAS3
+|Int64|✓|OAS2,OAS3
+|Float|✓|OAS2,OAS3
+|Double|✓|OAS2,OAS3
+|Decimal|✓|ToolingExtension
+|String|✓|OAS2,OAS3
+|Byte|✓|OAS2,OAS3
+|Binary|✓|OAS2,OAS3
+|Boolean|✓|OAS2,OAS3
+|Date|✓|OAS2,OAS3
+|DateTime|✓|OAS2,OAS3
+|Password|✓|OAS2,OAS3
+|File|✓|OAS2
+|Uuid|✗|
+|Array|✓|OAS2,OAS3
+|Null|✓|OAS3
+|AnyType|✓|OAS2,OAS3
+|Object|✓|OAS2,OAS3
+|Maps|✓|ToolingExtension
+|CollectionFormat|✓|OAS2
+|CollectionFormatMulti|✓|OAS2
+|Enum|✓|OAS2,OAS3
+|ArrayOfEnum|✓|ToolingExtension
+|ArrayOfModel|✓|ToolingExtension
+|ArrayOfCollectionOfPrimitives|✓|ToolingExtension
+|ArrayOfCollectionOfModel|✓|ToolingExtension
+|ArrayOfCollectionOfEnum|✓|ToolingExtension
+|MapOfEnum|✓|ToolingExtension
+|MapOfModel|✓|ToolingExtension
+|MapOfCollectionOfPrimitives|✓|ToolingExtension
+|MapOfCollectionOfModel|✓|ToolingExtension
+|MapOfCollectionOfEnum|✓|ToolingExtension
+
+### Documentation Feature
+| Name | Supported | Defined By |
+| ---- | --------- | ---------- |
+|Readme|✓|ToolingExtension
+|Model|✓|ToolingExtension
+|Api|✓|ToolingExtension
+
+### Global Feature
+| Name | Supported | Defined By |
+| ---- | --------- | ---------- |
+|Host|✓|OAS2,OAS3
+|BasePath|✓|OAS2,OAS3
+|Info|✓|OAS2,OAS3
+|Schemes|✗|OAS2,OAS3
+|PartialSchemes|✓|OAS2,OAS3
+|Consumes|✓|OAS2
+|Produces|✓|OAS2
+|ExternalDocumentation|✓|OAS2,OAS3
+|Examples|✓|OAS2,OAS3
+|XMLStructureDefinitions|✗|OAS2,OAS3
+|MultiServer|✗|OAS3
+|ParameterizedServer|✗|OAS3
+|ParameterStyling|✗|OAS3
+|Callbacks|✗|OAS3
+|LinkObjects|✗|OAS3
+
+### Parameter Feature
+| Name | Supported | Defined By |
+| ---- | --------- | ---------- |
+|Path|✓|OAS2,OAS3
+|Query|✓|OAS2,OAS3
+|Header|✓|OAS2,OAS3
+|Body|✓|OAS2
+|FormUnencoded|✓|OAS2
+|FormMultipart|✓|OAS2
+|Cookie|✗|OAS3
+
+### Schema Support Feature
+| Name | Supported | Defined By |
+| ---- | --------- | ---------- |
+|Simple|✓|OAS2,OAS3
+|Composite|✓|OAS2,OAS3
+|Polymorphism|✗|OAS2,OAS3
+|Union|✓|OAS3
+|allOf|✓|OAS2,OAS3
+|anyOf|✓|OAS3
+|oneOf|✓|OAS3
+|not|✗|OAS3
+
+### Security Feature
+| Name | Supported | Defined By |
+| ---- | --------- | ---------- |
+|BasicAuth|✗|OAS2,OAS3
+|ApiKey|✗|OAS2,OAS3
+|OpenIDConnect|✗|OAS3
+|BearerToken|✗|OAS3
+|OAuth2_Implicit|✗|OAS2,OAS3
+|OAuth2_Password|✗|OAS2,OAS3
+|OAuth2_ClientCredentials|✗|OAS2,OAS3
+|OAuth2_AuthorizationCode|✗|OAS2,OAS3
+|SignatureAuth|✗|OAS3
+|AWSV4Signature|✗|ToolingExtension
+
+### Wire Format Feature
+| Name | Supported | Defined By |
+| ---- | --------- | ---------- |
+|JSON|✓|OAS2,OAS3
+|XML|✗|OAS2,OAS3
+|PROTOBUF|✗|ToolingExtension
+|Custom|✗|OAS2,OAS3
+
+## ROADMAP
+
+Future enhancements planned:
+- Input validation with custom validators
+- Authentication middleware integration
+- OpenAPI 3.1 support
+- Performance optimizations
+- WebSocket support consideration
diff --git a/docs/generators/java-camel.md b/docs/generators/java-camel.md
index c64ebeaee66a..b50d9b4728c1 100644
--- a/docs/generators/java-camel.md
+++ b/docs/generators/java-camel.md
@@ -95,10 +95,12 @@ 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|
|sourceFolder|source folder for generated code| |src/main/java|
+|springApiVersion|Value for 'version' attribute in @RequestMapping (for Spring 7 and above).| |null|
|testOutput|Set output folder for models and APIs tests| |${project.build.directory}/generated-test-sources/openapi|
|title|server title name or client service name| |OpenAPI Spring|
|unhandledException|Declare operation methods to throw a generic exception and allow unhandled exceptions (useful for Spring `@ControllerAdvice` directives).| |false|
|useBeanValidation|Use BeanValidation API annotations| |true|
+|useDeductionForOneOfInterfaces|whether to use deduction for generated oneOf interfaces| |false|
|useEnumCaseInsensitive|Use `equalsIgnoreCase` when String for enum comparison| |false|
|useFeignClientContextId|Whether to generate Feign client with contextId parameter.| |true|
|useFeignClientUrl|Whether to generate Feign client with url parameter.| |true|
@@ -131,6 +133,10 @@ These options may be applied as additional-properties (cli) or configOptions (pl
|x-spring-paginated|Add `org.springframework.data.domain.Pageable` to controller method. Can be used to handle `page`, `size` and `sort` query parameters. If these query parameters are also specified in the operation spec, they will be removed from the controller method as their values can be obtained from the `Pageable` object.|OPERATION|false
|x-version-param|Marker property that tells that this parameter would be used for endpoint versioning. Applicable for headers & query params. true/false|OPERATION_PARAMETER|null
|x-pattern-message|Add this property whenever you need to customize the invalidation error message for the regex pattern of a variable|FIELD, OPERATION_PARAMETER|null
+|x-size-message|Add this property whenever you need to customize the invalidation error message for the size or length of a variable|FIELD, OPERATION_PARAMETER|null
+|x-minimum-message|Add this property whenever you need to customize the invalidation error message for the minimum value of a variable|FIELD, OPERATION_PARAMETER|null
+|x-maximum-message|Add this property whenever you need to customize the invalidation error message for the maximum value of a variable|FIELD, OPERATION_PARAMETER|null
+|x-spring-api-version|Value for 'version' attribute in @RequestMapping (for Spring 7 and above).|OPERATION|null
## IMPORT MAPPING
diff --git a/docs/generators/java-dubbo.md b/docs/generators/java-dubbo.md
new file mode 100644
index 000000000000..fa64f3d35955
--- /dev/null
+++ b/docs/generators/java-dubbo.md
@@ -0,0 +1,351 @@
+---
+title: Documentation for the java-dubbo Generator
+---
+
+## METADATA
+
+| Property | Value | Notes |
+| -------- | ----- | ----- |
+| generator name | java-dubbo | pass this to the generate command after -g |
+| generator stability | BETA | |
+| generator type | SERVER | |
+| generator language | Java | |
+| generator default templating engine | mustache | |
+| helpTxt | Generates a Java Apache Dubbo server application. | |
+
+## CONFIG OPTIONS
+These options may be applied as additional-properties (cli) or configOptions (plugins). Refer to [configuration docs](https://openapi-generator.tech/docs/configuration) for more details.
+
+| Option | Description | Values | Default |
+| ------ | ----------- | ------ | ------- |
+|additionalEnumTypeAnnotations|Additional annotations for enum type(class level annotations)| |null|
+|additionalModelTypeAnnotations|Additional annotations for model type(class level annotations). List separated by semicolon(;) or new line (Linux or Windows)| |null|
+|additionalOneOfTypeAnnotations|Additional annotations for oneOf interfaces(class level annotations). List separated by semicolon(;) or new line (Linux or Windows)| |null|
+|allowUnicodeIdentifiers|boolean, toggles whether unicode identifiers are allowed in names or not, default is false| |false|
+|apiPackage|package for generated api classes| |org.openapitools.api|
+|artifactDescription|artifact description in generated pom.xml| |OpenAPI Java|
+|artifactId|artifactId in generated pom.xml. This also becomes part of the generated library's filename| |openapi-dubbo|
+|artifactUrl|artifact URL in generated pom.xml| |https://github.com/openapitools/openapi-generator|
+|artifactVersion|artifact version in generated pom.xml. This also becomes part of the generated library's filename. If not provided, uses the version from the OpenAPI specification file. If that's also not present, uses the default value of the artifactVersion option.| |1.0.0|
+|basePackage|base package (invokerPackage) for generated code| |org.openapitools|
+|bigDecimalAsString|Treat BigDecimal values as Strings to avoid precision loss.| |false|
+|booleanGetterPrefix|Set booleanGetterPrefix| |get|
+|camelCaseDollarSign|Fix camelCase when starting with $ sign. when true : $Value when false : $value| |false|
+|configPackage|configuration package for generated code| |org.openapitools.configuration|
+|containerDefaultToNull|Set containers (array, set, map) default to null| |false|
+|dateLibrary|Option. Date library to use|
**joda**
Joda (for legacy app only)
**legacy**
Legacy java.util.Date
**java8-localdatetime**
Java 8 using LocalDateTime (for legacy app only)
**java8**
Java 8 native JSR310 (preferred for jdk 1.8+)
|java8|
+|developerEmail|developer email in generated pom.xml| |team@openapitools.org|
+|developerName|developer name in generated pom.xml| |OpenAPI-Generator Contributors|
+|developerOrganization|developer organization in generated pom.xml| |OpenAPITools.org|
+|developerOrganizationUrl|developer organization URL in generated pom.xml| |http://openapitools.org|
+|disableHtmlEscaping|Disable HTML escaping of JSON strings when using gson (needed to avoid problems with byte[] fields)| |false|
+|disallowAdditionalPropertiesIfNotPresent|If false, the 'additionalProperties' implementation (set to true by default) is compliant with the OAS and JSON schema specifications. If true (default), keep the old (incorrect) behaviour that 'additionalProperties' is set to false by default.|
**false**
The 'additionalProperties' implementation is compliant with the OAS and JSON schema specifications.
**true**
Keep the old (incorrect) behaviour that 'additionalProperties' is set to false by default.
|true|
+|discriminatorCaseSensitive|Whether the discriminator value lookup should be case-sensitive or not. This option only works for Java API client| |true|
+|dubboVersion|Dubbo version| |3.2.18|
+|ensureUniqueParams|Whether to ensure parameter names are unique in an operation (rename parameters that are not).| |true|
+|enumPropertyNaming|Naming convention for enum properties: 'MACRO_CASE', 'legacy' and 'original'| |MACRO_CASE|
+|enumUnknownDefaultCase|If the server adds new enum cases, that are unknown by an old spec/client, the client will fail to parse the network response.With this option enabled, each enum will have a new case, 'unknown_default_open_api', so that when the server sends an enum case that is not known by the client/spec, they can safely fallback to this case.|
**false**
No changes to the enum's are made, this is the default option.
**true**
With this option enabled, each enum will have a new case, 'unknown_default_open_api', so that when the enum case sent by the server is not known by the client/spec, can safely be decoded to this case.
|false|
+|generateBuilders|Whether to generate builders for models| |false|
+|generateConstructorWithAllArgs|whether to generate a constructor for all arguments| |false|
+|groupId|groupId in generated pom.xml| |org.openapitools|
+|hideGenerationTimestamp|Hides the generation timestamp when files are generated.| |false|
+|ignoreAnyOfInEnum|Ignore anyOf keyword in enum| |false|
+|implicitHeaders|Skip header parameters in the generated API methods using @ApiImplicitParams annotation.| |false|
+|implicitHeadersRegex|Skip header parameters that matches given regex in the generated API methods using @ApiImplicitParams annotation. Note: this parameter is ignored when implicitHeaders=true| |null|
+|interfaceOnly|Whether to generate only API interface stubs without the server files.| |false|
+|invokerPackage|root package for generated code| |org.openapitools|
+|javaVersion|Java version| |17|
+|legacyDiscriminatorBehavior|Set to false for generators with better support for discriminators. (Python, Java, Go, PowerShell, C# have this enabled by default).|
**true**
The mapping in the discriminator includes descendent schemas that allOf inherit from self and the discriminator mapping schemas in the OAS document.
**false**
The mapping in the discriminator includes any descendent schemas that allOf inherit from self, any oneOf schemas, any anyOf schemas, any x-discriminator-values, and the discriminator mapping schemas in the OAS document AND Codegen validates that oneOf and anyOf schemas contain the required discriminator and throws an error if the discriminator is missing.
|true|
+|licenseName|The name of the license| |Unlicense|
+|licenseUrl|The URL of the license| |http://unlicense.org|
+|modelPackage|package for generated models| |org.openapitools.model|
+|openApiNullable|Enable OpenAPI Jackson Nullable library. Not supported by `microprofile` library.| |true|
+|parentArtifactId|parent artifactId in generated pom N.B. parentGroupId, parentArtifactId and parentVersion must all be specified for any of them to take effect| |null|
+|parentGroupId|parent groupId in generated pom N.B. parentGroupId, parentArtifactId and parentVersion must all be specified for any of them to take effect| |null|
+|parentVersion|parent version in generated pom N.B. parentGroupId, parentArtifactId and parentVersion must all be specified for any of them to take effect| |null|
+|prependFormOrBodyParameters|Add form or body parameters to the beginning of the parameter list.| |false|
+|registry-address|Registry address (e.g., zookeeper://127.0.0.1:2181 or nacos://127.0.0.1:8848)| |zookeeper://127.0.0.1:2181|
+|scmConnection|SCM connection in generated pom.xml| |scm:git:git@github.com:openapitools/openapi-generator.git|
+|scmDeveloperConnection|SCM developer connection in generated pom.xml| |scm:git:git@github.com:openapitools/openapi-generator.git|
+|scmUrl|SCM URL in generated pom.xml| |https://github.com/openapitools/openapi-generator|
+|serializableModel|boolean - toggle "implements Serializable" for generated models| |false|
+|serviceImplementation|Generate service implementation| |true|
+|serviceInterface|Generate service interface| |true|
+|snapshotVersion|Uses a SNAPSHOT version.|
**true**
Use a SnapShot Version
**false**
Use a Release Version
|null|
+|sortModelPropertiesByRequiredFlag|Sort model properties to place required parameters before optional parameters.| |true|
+|sortParamsByRequiredFlag|Sort method arguments to place required parameters before optional parameters.| |true|
+|sourceFolder|source folder for generated code| |src/main/java|
+|testOutput|Set output folder for models and APIs tests| |${project.build.directory}/generated-test-sources/openapi|
+|title|API title name| |null|
+|useGenericResponse|Use generic response wrapper| |false|
+|useJakartaEe|whether to use Jakarta EE namespace instead of javax| |false|
+|useOneOfInterfaces|whether to use a java interface to describe a set of oneOf options, where each option is a class that implements the interface| |false|
+|useTags|use tags for creating interface and controller classnames| |true|
+|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-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, OPERATION_PARAMETER|null
+
+
+## IMPORT MAPPING
+
+| Type/Alias | Imports |
+| ---------- | ------- |
+|Array|java.util.List|
+|ArrayList|java.util.ArrayList|
+|Arrays|java.util.Arrays|
+|BigDecimal|java.math.BigDecimal|
+|BigInteger|java.math.BigInteger|
+|Date|java.util.Date|
+|DateTime|org.joda.time.*|
+|File|java.io.File|
+|HashMap|java.util.HashMap|
+|HashSet|java.util.HashSet|
+|LinkedHashSet|java.util.LinkedHashSet|
+|List|java.util.List|
+|LocalDate|java.time.LocalDate|
+|LocalDateTime|java.time.LocalDateTime|
+|LocalTime|java.time.LocalTime|
+|Map|java.util.Map|
+|MultipartFile|org.springframework.web.multipart.MultipartFile|
+|OffsetDateTime|java.time.OffsetDateTime|
+|Set|java.util.Set|
+|Timestamp|java.sql.Timestamp|
+|URI|java.net.URI|
+|UUID|java.util.UUID|
+
+
+## INSTANTIATION TYPES
+
+| Type/Alias | Instantiated By |
+| ---------- | --------------- |
+|array|ArrayList|
+|map|HashMap|
+|set|LinkedHashSet|
+
+
+## LANGUAGE PRIMITIVES
+
+
+
Boolean
+
Double
+
Float
+
Integer
+
List
+
Long
+
Map
+
Object
+
Set
+
String
+
boolean
+
+
+## RESERVED WORDS
+
+
+
_
+
abstract
+
apiclient
+
apiexception
+
apiresponse
+
assert
+
boolean
+
break
+
byte
+
case
+
catch
+
char
+
class
+
configuration
+
const
+
continue
+
default
+
do
+
double
+
else
+
enum
+
extends
+
file
+
final
+
finally
+
float
+
for
+
goto
+
if
+
implements
+
import
+
instanceof
+
int
+
interface
+
list
+
localdate
+
localreturntype
+
localtime
+
localvaraccept
+
localvaraccepts
+
localvarauthnames
+
localvarcollectionqueryparams
+
localvarcontenttype
+
localvarcontenttypes
+
localvarcookieparams
+
localvarformparams
+
localvarheaderparams
+
localvarpath
+
localvarpostbody
+
localvarqueryparams
+
long
+
native
+
new
+
null
+
object
+
offsetdatetime
+
package
+
private
+
protected
+
public
+
return
+
short
+
static
+
strictfp
+
stringutil
+
super
+
switch
+
synchronized
+
this
+
throw
+
throws
+
transient
+
try
+
void
+
volatile
+
while
+
+
+## FEATURE SET
+
+
+### Client Modification Feature
+| Name | Supported | Defined By |
+| ---- | --------- | ---------- |
+|BasePath|✓|ToolingExtension
+|Authorizations|✗|ToolingExtension
+|UserAgent|✗|ToolingExtension
+|MockServer|✗|ToolingExtension
+
+### Data Type Feature
+| Name | Supported | Defined By |
+| ---- | --------- | ---------- |
+|Custom|✗|OAS2,OAS3
+|Int32|✓|OAS2,OAS3
+|Int64|✓|OAS2,OAS3
+|Float|✓|OAS2,OAS3
+|Double|✓|OAS2,OAS3
+|Decimal|✓|ToolingExtension
+|String|✓|OAS2,OAS3
+|Byte|✓|OAS2,OAS3
+|Binary|✓|OAS2,OAS3
+|Boolean|✓|OAS2,OAS3
+|Date|✓|OAS2,OAS3
+|DateTime|✓|OAS2,OAS3
+|Password|✓|OAS2,OAS3
+|File|✓|OAS2
+|Uuid|✗|
+|Array|✓|OAS2,OAS3
+|Null|✗|OAS3
+|AnyType|✗|OAS2,OAS3
+|Object|✓|OAS2,OAS3
+|Maps|✓|ToolingExtension
+|CollectionFormat|✓|OAS2
+|CollectionFormatMulti|✓|OAS2
+|Enum|✓|OAS2,OAS3
+|ArrayOfEnum|✓|ToolingExtension
+|ArrayOfModel|✓|ToolingExtension
+|ArrayOfCollectionOfPrimitives|✓|ToolingExtension
+|ArrayOfCollectionOfModel|✓|ToolingExtension
+|ArrayOfCollectionOfEnum|✓|ToolingExtension
+|MapOfEnum|✓|ToolingExtension
+|MapOfModel|✓|ToolingExtension
+|MapOfCollectionOfPrimitives|✓|ToolingExtension
+|MapOfCollectionOfModel|✓|ToolingExtension
+|MapOfCollectionOfEnum|✓|ToolingExtension
+
+### Documentation Feature
+| Name | Supported | Defined By |
+| ---- | --------- | ---------- |
+|Readme|✓|ToolingExtension
+|Model|✓|ToolingExtension
+|Api|✓|ToolingExtension
+
+### Global Feature
+| Name | Supported | Defined By |
+| ---- | --------- | ---------- |
+|Host|✓|OAS2,OAS3
+|BasePath|✓|OAS2,OAS3
+|Info|✓|OAS2,OAS3
+|Schemes|✗|OAS2,OAS3
+|PartialSchemes|✓|OAS2,OAS3
+|Consumes|✓|OAS2
+|Produces|✓|OAS2
+|ExternalDocumentation|✓|OAS2,OAS3
+|Examples|✓|OAS2,OAS3
+|XMLStructureDefinitions|✗|OAS2,OAS3
+|MultiServer|✗|OAS3
+|ParameterizedServer|✗|OAS3
+|ParameterStyling|✗|OAS3
+|Callbacks|✗|OAS3
+|LinkObjects|✗|OAS3
+
+### Parameter Feature
+| Name | Supported | Defined By |
+| ---- | --------- | ---------- |
+|Path|✓|OAS2,OAS3
+|Query|✓|OAS2,OAS3
+|Header|✓|OAS2,OAS3
+|Body|✓|OAS2
+|FormUnencoded|✓|OAS2
+|FormMultipart|✓|OAS2
+|Cookie|✗|OAS3
+
+### Schema Support Feature
+| Name | Supported | Defined By |
+| ---- | --------- | ---------- |
+|Simple|✓|OAS2,OAS3
+|Composite|✓|OAS2,OAS3
+|Polymorphism|✓|OAS2,OAS3
+|Union|✗|OAS3
+|allOf|✗|OAS2,OAS3
+|anyOf|✗|OAS3
+|oneOf|✗|OAS3
+|not|✗|OAS3
+
+### Security Feature
+| Name | Supported | Defined By |
+| ---- | --------- | ---------- |
+|BasicAuth|✓|OAS2,OAS3
+|ApiKey|✓|OAS2,OAS3
+|OpenIDConnect|✗|OAS3
+|BearerToken|✗|OAS3
+|OAuth2_Implicit|✓|OAS2,OAS3
+|OAuth2_Password|✓|OAS2,OAS3
+|OAuth2_ClientCredentials|✓|OAS2,OAS3
+|OAuth2_AuthorizationCode|✓|OAS2,OAS3
+|SignatureAuth|✗|OAS3
+|AWSV4Signature|✗|ToolingExtension
+
+### Wire Format Feature
+| Name | Supported | Defined By |
+| ---- | --------- | ---------- |
+|JSON|✓|OAS2,OAS3
+|XML|✓|OAS2,OAS3
+|PROTOBUF|✗|ToolingExtension
+|Custom|✓|OAS2,OAS3
diff --git a/docs/generators/jaxrs-cxf-cdi.md b/docs/generators/jaxrs-cxf-cdi.md
index 48bf8680e429..02f6b177827e 100644
--- a/docs/generators/jaxrs-cxf-cdi.md
+++ b/docs/generators/jaxrs-cxf-cdi.md
@@ -64,6 +64,7 @@ These options may be applied as additional-properties (cli) or configOptions (pl
|parentGroupId|parent groupId in generated pom N.B. parentGroupId, parentArtifactId and parentVersion must all be specified for any of them to take effect| |null|
|parentVersion|parent version in generated pom N.B. parentGroupId, parentArtifactId and parentVersion must all be specified for any of them to take effect| |null|
|prependFormOrBodyParameters|Add form or body parameters to the beginning of the parameter list.| |false|
+|returnJBossResponse|Whether generate API interface should return `org.jboss.resteasy.reactive.RestResponse` instead of a deserialized entity. This flag cannot be combined with `returnResponse` flag. It requires the flag `interfaceOnly` and `useJakartaEE` set to true, because `org.jboss.resteasy.reactive.RestResponse` was introduced in Quarkus 2.x| |false|
|returnResponse|Whether generate API interface should return javax.ws.rs.core.Response instead of a deserialized entity. Only useful if interfaceOnly is true.| |false|
|scmConnection|SCM connection in generated pom.xml| |scm:git:git@github.com:openapitools/openapi-generator.git|
|scmDeveloperConnection|SCM developer connection in generated pom.xml| |scm:git:git@github.com:openapitools/openapi-generator.git|
@@ -83,6 +84,7 @@ These options may be applied as additional-properties (cli) or configOptions (pl
|useMutiny|Whether to use Smallrye Mutiny instead of CompletionStage for asynchronous computation. Only valid when library is set to quarkus.| |false|
|useOneOfInterfaces|whether to use a java interface to describe a set of oneOf options, where each option is a class that implements the interface| |false|
|useSwaggerAnnotations|Whether to generate Swagger annotations.| |true|
+|useSwaggerV3Annotations|Whether to generate Swagger v3 (OpenAPI v3) annotations.| |false|
|useTags|use tags for creating interface and controller classnames| |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|
diff --git a/docs/generators/jaxrs-cxf-client.md b/docs/generators/jaxrs-cxf-client.md
index 4dac27cd01f8..e735d8f0ef4b 100644
--- a/docs/generators/jaxrs-cxf-client.md
+++ b/docs/generators/jaxrs-cxf-client.md
@@ -22,6 +22,7 @@ These options may be applied as additional-properties (cli) or configOptions (pl
|additionalModelTypeAnnotations|Additional annotations for model type(class level annotations). List separated by semicolon(;) or new line (Linux or Windows)| |null|
|additionalOneOfTypeAnnotations|Additional annotations for oneOf interfaces(class level annotations). List separated by semicolon(;) or new line (Linux or Windows)| |null|
|allowUnicodeIdentifiers|boolean, toggles whether unicode identifiers are allowed in names or not, default is false| |false|
+|annotationLibrary|Select the complementary documentation annotation library.|
**none**
Do not annotate Model and Api with complementary annotations.
**swagger1**
Annotate Model and Api using the Swagger Annotations 1.x library.
**swagger2**
Annotate Model and Api using the Swagger Annotations 2.x library.
|swagger1|
|apiPackage|package for generated api classes| |org.openapitools.api|
|artifactDescription|artifact description in generated pom.xml| |OpenAPI Java|
|artifactId|artifactId in generated pom.xml. This also becomes part of the generated library's filename| |openapi-jaxrs-client|
@@ -39,6 +40,7 @@ These options may be applied as additional-properties (cli) or configOptions (pl
|disableHtmlEscaping|Disable HTML escaping of JSON strings when using gson (needed to avoid problems with byte[] fields)| |false|
|disallowAdditionalPropertiesIfNotPresent|If false, the 'additionalProperties' implementation (set to true by default) is compliant with the OAS and JSON schema specifications. If true (default), keep the old (incorrect) behaviour that 'additionalProperties' is set to false by default.|
**false**
The 'additionalProperties' implementation is compliant with the OAS and JSON schema specifications.
**true**
Keep the old (incorrect) behaviour that 'additionalProperties' is set to false by default.
|true|
|discriminatorCaseSensitive|Whether the discriminator value lookup should be case-sensitive or not. This option only works for Java API client| |true|
+|documentationProvider|Select the OpenAPI documentation provider.|
**none**
Do not publish an OpenAPI specification.
**swagger1**
Generate an OpenAPI 2 (fka Swagger RESTful API Documentation Specification) specification using Swagger-Core 1.x.
**swagger2**
Generate an OpenAPI 3 specification using Swagger-Core 2.x.
|swagger1|
|ensureUniqueParams|Whether to ensure parameter names are unique in an operation (rename parameters that are not).| |true|
|enumPropertyNaming|Naming convention for enum properties: 'MACRO_CASE', 'legacy' and 'original'| |MACRO_CASE|
|enumUnknownDefaultCase|If the server adds new enum cases, that are unknown by an old spec/client, the client will fail to parse the network response.With this option enabled, each enum will have a new case, 'unknown_default_open_api', so that when the server sends an enum case that is not known by the client/spec, they can safely fallback to this case.|
**false**
No changes to the enum's are made, this is the default option.
**true**
With this option enabled, each enum will have a new case, 'unknown_default_open_api', so that when the enum case sent by the server is not known by the client/spec, can safely be decoded to this case.
|false|
diff --git a/docs/generators/jaxrs-cxf-extended.md b/docs/generators/jaxrs-cxf-extended.md
index 4d22ef800238..aeb82d2dce55 100644
--- a/docs/generators/jaxrs-cxf-extended.md
+++ b/docs/generators/jaxrs-cxf-extended.md
@@ -23,6 +23,7 @@ These options may be applied as additional-properties (cli) or configOptions (pl
|additionalModelTypeAnnotations|Additional annotations for model type(class level annotations). List separated by semicolon(;) or new line (Linux or Windows)| |null|
|additionalOneOfTypeAnnotations|Additional annotations for oneOf interfaces(class level annotations). List separated by semicolon(;) or new line (Linux or Windows)| |null|
|allowUnicodeIdentifiers|boolean, toggles whether unicode identifiers are allowed in names or not, default is false| |false|
+|annotationLibrary|Select the complementary documentation annotation library.|
**none**
Do not annotate Model and Api with complementary annotations.
**swagger1**
Annotate Model and Api using the Swagger Annotations 1.x library.
**swagger2**
Annotate Model and Api using the Swagger Annotations 2.x library.
|swagger1|
|apiPackage|package for generated api classes| |org.openapitools.api|
|artifactDescription|artifact description in generated pom.xml| |OpenAPI Java|
|artifactId|artifactId in generated pom.xml. This also becomes part of the generated library's filename| |openapi-cxf-server|
@@ -40,6 +41,7 @@ These options may be applied as additional-properties (cli) or configOptions (pl
|disableHtmlEscaping|Disable HTML escaping of JSON strings when using gson (needed to avoid problems with byte[] fields)| |false|
|disallowAdditionalPropertiesIfNotPresent|If false, the 'additionalProperties' implementation (set to true by default) is compliant with the OAS and JSON schema specifications. If true (default), keep the old (incorrect) behaviour that 'additionalProperties' is set to false by default.|
**false**
The 'additionalProperties' implementation is compliant with the OAS and JSON schema specifications.
**true**
Keep the old (incorrect) behaviour that 'additionalProperties' is set to false by default.
|true|
|discriminatorCaseSensitive|Whether the discriminator value lookup should be case-sensitive or not. This option only works for Java API client| |true|
+|documentationProvider|Select the OpenAPI documentation provider.|
**none**
Do not publish an OpenAPI specification.
**swagger1**
Generate an OpenAPI 2 (fka Swagger RESTful API Documentation Specification) specification using Swagger-Core 1.x.
**swagger2**
Generate an OpenAPI 3 specification using Swagger-Core 2.x.
|swagger1|
|ensureUniqueParams|Whether to ensure parameter names are unique in an operation (rename parameters that are not).| |true|
|enumPropertyNaming|Naming convention for enum properties: 'MACRO_CASE', 'legacy' and 'original'| |MACRO_CASE|
|enumUnknownDefaultCase|If the server adds new enum cases, that are unknown by an old spec/client, the client will fail to parse the network response.With this option enabled, each enum will have a new case, 'unknown_default_open_api', so that when the server sends an enum case that is not known by the client/spec, they can safely fallback to this case.|
**false**
No changes to the enum's are made, this is the default option.
**true**
With this option enabled, each enum will have a new case, 'unknown_default_open_api', so that when the enum case sent by the server is not known by the client/spec, can safely be decoded to this case.
|false|
diff --git a/docs/generators/jaxrs-cxf.md b/docs/generators/jaxrs-cxf.md
index d3be4bdfd71c..b9b120e2f8d9 100644
--- a/docs/generators/jaxrs-cxf.md
+++ b/docs/generators/jaxrs-cxf.md
@@ -23,6 +23,7 @@ These options may be applied as additional-properties (cli) or configOptions (pl
|additionalModelTypeAnnotations|Additional annotations for model type(class level annotations). List separated by semicolon(;) or new line (Linux or Windows)| |null|
|additionalOneOfTypeAnnotations|Additional annotations for oneOf interfaces(class level annotations). List separated by semicolon(;) or new line (Linux or Windows)| |null|
|allowUnicodeIdentifiers|boolean, toggles whether unicode identifiers are allowed in names or not, default is false| |false|
+|annotationLibrary|Select the complementary documentation annotation library.|
**none**
Do not annotate Model and Api with complementary annotations.
**swagger1**
Annotate Model and Api using the Swagger Annotations 1.x library.
**swagger2**
Annotate Model and Api using the Swagger Annotations 2.x library.
|swagger1|
|apiPackage|package for generated api classes| |org.openapitools.api|
|artifactDescription|artifact description in generated pom.xml| |OpenAPI Java|
|artifactId|artifactId in generated pom.xml. This also becomes part of the generated library's filename| |openapi-cxf-server|
@@ -40,6 +41,7 @@ These options may be applied as additional-properties (cli) or configOptions (pl
|disableHtmlEscaping|Disable HTML escaping of JSON strings when using gson (needed to avoid problems with byte[] fields)| |false|
|disallowAdditionalPropertiesIfNotPresent|If false, the 'additionalProperties' implementation (set to true by default) is compliant with the OAS and JSON schema specifications. If true (default), keep the old (incorrect) behaviour that 'additionalProperties' is set to false by default.|
**false**
The 'additionalProperties' implementation is compliant with the OAS and JSON schema specifications.
**true**
Keep the old (incorrect) behaviour that 'additionalProperties' is set to false by default.
|true|
|discriminatorCaseSensitive|Whether the discriminator value lookup should be case-sensitive or not. This option only works for Java API client| |true|
+|documentationProvider|Select the OpenAPI documentation provider.|
**none**
Do not publish an OpenAPI specification.
**swagger1**
Generate an OpenAPI 2 (fka Swagger RESTful API Documentation Specification) specification using Swagger-Core 1.x.
**swagger2**
Generate an OpenAPI 3 specification using Swagger-Core 2.x.
|swagger1|
|ensureUniqueParams|Whether to ensure parameter names are unique in an operation (rename parameters that are not).| |true|
|enumPropertyNaming|Naming convention for enum properties: 'MACRO_CASE', 'legacy' and 'original'| |MACRO_CASE|
|enumUnknownDefaultCase|If the server adds new enum cases, that are unknown by an old spec/client, the client will fail to parse the network response.With this option enabled, each enum will have a new case, 'unknown_default_open_api', so that when the server sends an enum case that is not known by the client/spec, they can safely fallback to this case.|
**false**
No changes to the enum's are made, this is the default option.
**true**
With this option enabled, each enum will have a new case, 'unknown_default_open_api', so that when the enum case sent by the server is not known by the client/spec, can safely be decoded to this case.
|false|
diff --git a/docs/generators/jaxrs-spec.md b/docs/generators/jaxrs-spec.md
index 3fb5eee1064d..03c2d043bf78 100644
--- a/docs/generators/jaxrs-spec.md
+++ b/docs/generators/jaxrs-spec.md
@@ -65,6 +65,7 @@ These options may be applied as additional-properties (cli) or configOptions (pl
|parentGroupId|parent groupId in generated pom N.B. parentGroupId, parentArtifactId and parentVersion must all be specified for any of them to take effect| |null|
|parentVersion|parent version in generated pom N.B. parentGroupId, parentArtifactId and parentVersion must all be specified for any of them to take effect| |null|
|prependFormOrBodyParameters|Add form or body parameters to the beginning of the parameter list.| |false|
+|returnJBossResponse|Whether generate API interface should return `org.jboss.resteasy.reactive.RestResponse` instead of a deserialized entity. This flag cannot be combined with `returnResponse` flag. It requires the flag `interfaceOnly` and `useJakartaEE` set to true, because `org.jboss.resteasy.reactive.RestResponse` was introduced in Quarkus 2.x| |false|
|returnResponse|Whether generate API interface should return javax.ws.rs.core.Response instead of a deserialized entity. Only useful if interfaceOnly is true.| |false|
|scmConnection|SCM connection in generated pom.xml| |scm:git:git@github.com:openapitools/openapi-generator.git|
|scmDeveloperConnection|SCM developer connection in generated pom.xml| |scm:git:git@github.com:openapitools/openapi-generator.git|
@@ -84,6 +85,7 @@ These options may be applied as additional-properties (cli) or configOptions (pl
|useMutiny|Whether to use Smallrye Mutiny instead of CompletionStage for asynchronous computation. Only valid when library is set to quarkus.| |false|
|useOneOfInterfaces|whether to use a java interface to describe a set of oneOf options, where each option is a class that implements the interface| |false|
|useSwaggerAnnotations|Whether to generate Swagger annotations.| |true|
+|useSwaggerV3Annotations|Whether to generate Swagger v3 (OpenAPI v3) annotations.| |false|
|useTags|use tags for creating interface and controller classnames| |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|
diff --git a/docs/generators/kotlin-spring.md b/docs/generators/kotlin-spring.md
index 195c51460ef6..e79fdd782b70 100644
--- a/docs/generators/kotlin-spring.md
+++ b/docs/generators/kotlin-spring.md
@@ -67,6 +67,11 @@ These options may be applied as additional-properties (cli) or configOptions (pl
|x-discriminator-value|Used with model inheritance to specify value for discriminator that identifies current model|MODEL|
|x-field-extra-annotation|List of custom annotations to be added to property|FIELD, OPERATION_PARAMETER|null
|x-pattern-message|Add this property whenever you need to customize the invalidation error message for the regex pattern of a variable|FIELD, OPERATION_PARAMETER|null
+|x-size-message|Add this property whenever you need to customize the invalidation error message for the size or length of a variable|FIELD, OPERATION_PARAMETER|null
+|x-minimum-message|Add this property whenever you need to customize the invalidation error message for the minimum value of a variable|FIELD, OPERATION_PARAMETER|null
+|x-maximum-message|Add this property whenever you need to customize the invalidation error message for the maximum value of a variable|FIELD, OPERATION_PARAMETER|null
+|x-kotlin-implements|Ability to specify interfaces that model must implement|MODEL|empty array
+|x-kotlin-implements-fields|Specify attributes that are implemented by the interface(s) added via `x-kotlin-implements`|MODEL|empty array
## IMPORT MAPPING
diff --git a/docs/generators/postman.md b/docs/generators/postman.md
deleted file mode 100644
index 7127a1ab05d6..000000000000
--- a/docs/generators/postman.md
+++ /dev/null
@@ -1,167 +0,0 @@
----
-title: Documentation for the postman Generator
----
-
-## METADATA
-
-| Property | Value | Notes |
-| -------- | ----- | ----- |
-| generator name | postman | pass this to the generate command after -g |
-| generator stability | BETA | |
-| generator type | DOCUMENTATION | |
-| generator default templating engine | mustache | |
-| helpTxt | Generates a postman JSON file | |
-
-## CONFIG OPTIONS
-These options may be applied as additional-properties (cli) or configOptions (plugins). Refer to [configuration docs](https://openapi-generator.tech/docs/configuration) for more details.
-
-| Option | Description | Values | Default |
-| ------ | ----------- | ------ | ------- |
-|folderStrategy|whether to create folders according to the spec’s paths or tags| |null|
-|pathParamsAsVariables|whether to create Postman variables for path parameters| |false|
-|postmanGuid|whether to convert placeholders (i.e. {{UNIQUE_REFERENCE}}) into Postman formula {{$guid}}| |null|
-|postmanGuidPlaceholderName|name of the placeholder (i.e. {{UNIQUE_REFERENCE}}) to replace with Postman formula {{$guid}}| |null|
-|postmanIsoTimestamp|whether to convert placeholders (i.e. {{ISO_TIMESTAMP}}) into Postman formula {{$isoTimestamp}}| |null|
-|postmanIsoTimestampPlaceholderName|name of the placeholder (i.e. {{ISO_TIMESTAMP}}) to replace with Postman formula {{$isoTimestamp}}| |null|
-|postmanVariables|whether to convert placeholders (i.e. {{VAR_1}}) into Postman variables| |null|
-|requestParameterGeneration|whether to generate the request parameters based on the schema or the examples| |null|
-
-## IMPORT MAPPING
-
-| Type/Alias | Imports |
-| ---------- | ------- |
-
-
-## INSTANTIATION TYPES
-
-| Type/Alias | Instantiated By |
-| ---------- | --------------- |
-
-
-## LANGUAGE PRIMITIVES
-
-
-
-
-## RESERVED WORDS
-
-
-
-
-## FEATURE SET
-
-
-### Client Modification Feature
-| Name | Supported | Defined By |
-| ---- | --------- | ---------- |
-|BasePath|✗|ToolingExtension
-|Authorizations|✗|ToolingExtension
-|UserAgent|✗|ToolingExtension
-|MockServer|✗|ToolingExtension
-
-### Data Type Feature
-| Name | Supported | Defined By |
-| ---- | --------- | ---------- |
-|Custom|✗|OAS2,OAS3
-|Int32|✓|OAS2,OAS3
-|Int64|✓|OAS2,OAS3
-|Float|✓|OAS2,OAS3
-|Double|✓|OAS2,OAS3
-|Decimal|✓|ToolingExtension
-|String|✓|OAS2,OAS3
-|Byte|✓|OAS2,OAS3
-|Binary|✓|OAS2,OAS3
-|Boolean|✓|OAS2,OAS3
-|Date|✓|OAS2,OAS3
-|DateTime|✓|OAS2,OAS3
-|Password|✓|OAS2,OAS3
-|File|✓|OAS2
-|Uuid|✗|
-|Array|✓|OAS2,OAS3
-|Null|✗|OAS3
-|AnyType|✗|OAS2,OAS3
-|Object|✓|OAS2,OAS3
-|Maps|✓|ToolingExtension
-|CollectionFormat|✓|OAS2
-|CollectionFormatMulti|✓|OAS2
-|Enum|✓|OAS2,OAS3
-|ArrayOfEnum|✓|ToolingExtension
-|ArrayOfModel|✓|ToolingExtension
-|ArrayOfCollectionOfPrimitives|✓|ToolingExtension
-|ArrayOfCollectionOfModel|✓|ToolingExtension
-|ArrayOfCollectionOfEnum|✓|ToolingExtension
-|MapOfEnum|✓|ToolingExtension
-|MapOfModel|✓|ToolingExtension
-|MapOfCollectionOfPrimitives|✓|ToolingExtension
-|MapOfCollectionOfModel|✓|ToolingExtension
-|MapOfCollectionOfEnum|✓|ToolingExtension
-
-### Documentation Feature
-| Name | Supported | Defined By |
-| ---- | --------- | ---------- |
-|Readme|✗|ToolingExtension
-|Model|✓|ToolingExtension
-|Api|✓|ToolingExtension
-
-### Global Feature
-| Name | Supported | Defined By |
-| ---- | --------- | ---------- |
-|Host|✓|OAS2,OAS3
-|BasePath|✓|OAS2,OAS3
-|Info|✓|OAS2,OAS3
-|Schemes|✗|OAS2,OAS3
-|PartialSchemes|✓|OAS2,OAS3
-|Consumes|✓|OAS2
-|Produces|✓|OAS2
-|ExternalDocumentation|✓|OAS2,OAS3
-|Examples|✓|OAS2,OAS3
-|XMLStructureDefinitions|✗|OAS2,OAS3
-|MultiServer|✗|OAS3
-|ParameterizedServer|✗|OAS3
-|ParameterStyling|✗|OAS3
-|Callbacks|✓|OAS3
-|LinkObjects|✗|OAS3
-
-### Parameter Feature
-| Name | Supported | Defined By |
-| ---- | --------- | ---------- |
-|Path|✓|OAS2,OAS3
-|Query|✓|OAS2,OAS3
-|Header|✓|OAS2,OAS3
-|Body|✓|OAS2
-|FormUnencoded|✓|OAS2
-|FormMultipart|✓|OAS2
-|Cookie|✓|OAS3
-
-### Schema Support Feature
-| Name | Supported | Defined By |
-| ---- | --------- | ---------- |
-|Simple|✓|OAS2,OAS3
-|Composite|✓|OAS2,OAS3
-|Polymorphism|✓|OAS2,OAS3
-|Union|✗|OAS3
-|allOf|✗|OAS2,OAS3
-|anyOf|✗|OAS3
-|oneOf|✗|OAS3
-|not|✗|OAS3
-
-### Security Feature
-| Name | Supported | Defined By |
-| ---- | --------- | ---------- |
-|BasicAuth|✓|OAS2,OAS3
-|ApiKey|✓|OAS2,OAS3
-|OpenIDConnect|✗|OAS3
-|BearerToken|✓|OAS3
-|OAuth2_Implicit|✓|OAS2,OAS3
-|OAuth2_Password|✓|OAS2,OAS3
-|OAuth2_ClientCredentials|✓|OAS2,OAS3
-|OAuth2_AuthorizationCode|✓|OAS2,OAS3
-|SignatureAuth|✗|OAS3
-
-### Wire Format Feature
-| Name | Supported | Defined By |
-| ---- | --------- | ---------- |
-|JSON|✓|OAS2,OAS3
-|XML|✓|OAS2,OAS3
-|PROTOBUF|✗|ToolingExtension
-|Custom|✗|OAS2,OAS3
diff --git a/docs/generators/python-aiohttp.md b/docs/generators/python-aiohttp.md
index b99acea11527..22f61793ba8e 100644
--- a/docs/generators/python-aiohttp.md
+++ b/docs/generators/python-aiohttp.md
@@ -55,6 +55,7 @@ These options may be applied as additional-properties (cli) or configOptions (pl
Dict
List
+
UUID
bool
bytes
date
@@ -155,7 +156,7 @@ These options may be applied as additional-properties (cli) or configOptions (pl
|DateTime|✓|OAS2,OAS3
|Password|✓|OAS2,OAS3
|File|✓|OAS2
-|Uuid|✗|
+|Uuid|✓|
|Array|✓|OAS2,OAS3
|Null|✗|OAS3
|AnyType|✗|OAS2,OAS3
diff --git a/docs/generators/python-blueplanet.md b/docs/generators/python-blueplanet.md
index 2702fd49c5fe..50c0aa7f3b84 100644
--- a/docs/generators/python-blueplanet.md
+++ b/docs/generators/python-blueplanet.md
@@ -55,6 +55,7 @@ These options may be applied as additional-properties (cli) or configOptions (pl
Dict
List
+
UUID
bool
bytes
date
@@ -155,7 +156,7 @@ These options may be applied as additional-properties (cli) or configOptions (pl
|DateTime|✓|OAS2,OAS3
|Password|✓|OAS2,OAS3
|File|✓|OAS2
-|Uuid|✗|
+|Uuid|✓|
|Array|✓|OAS2,OAS3
|Null|✗|OAS3
|AnyType|✗|OAS2,OAS3
diff --git a/docs/generators/python-fastapi.md b/docs/generators/python-fastapi.md
index 0beee68d757d..5a87a2fcee28 100644
--- a/docs/generators/python-fastapi.md
+++ b/docs/generators/python-fastapi.md
@@ -50,6 +50,7 @@ These options may be applied as additional-properties (cli) or configOptions (pl
Dict
List
+
UUID
bool
bytes
date
@@ -150,7 +151,7 @@ These options may be applied as additional-properties (cli) or configOptions (pl
|DateTime|✓|OAS2,OAS3
|Password|✓|OAS2,OAS3
|File|✓|OAS2
-|Uuid|✗|
+|Uuid|✓|
|Array|✓|OAS2,OAS3
|Null|✗|OAS3
|AnyType|✗|OAS2,OAS3
diff --git a/docs/generators/python-flask.md b/docs/generators/python-flask.md
index 81be38100b7e..0f8e85f4f031 100644
--- a/docs/generators/python-flask.md
+++ b/docs/generators/python-flask.md
@@ -55,6 +55,7 @@ These options may be applied as additional-properties (cli) or configOptions (pl
Dict
List
+
UUID
bool
bytes
date
@@ -155,7 +156,7 @@ These options may be applied as additional-properties (cli) or configOptions (pl
|DateTime|✓|OAS2,OAS3
|Password|✓|OAS2,OAS3
|File|✓|OAS2
-|Uuid|✗|
+|Uuid|✓|
|Array|✓|OAS2,OAS3
|Null|✗|OAS3
|AnyType|✗|OAS2,OAS3
diff --git a/docs/generators/python.md b/docs/generators/python.md
index 51b011e04409..e0706592cdff 100644
--- a/docs/generators/python.md
+++ b/docs/generators/python.md
@@ -24,7 +24,8 @@ These options may be applied as additional-properties (cli) or configOptions (pl
|disallowAdditionalPropertiesIfNotPresent|If false, the 'additionalProperties' implementation (set to true by default) is compliant with the OAS and JSON schema specifications. If true (default), keep the old (incorrect) behaviour that 'additionalProperties' is set to false by default.|
**false**
The 'additionalProperties' implementation is compliant with the OAS and JSON schema specifications.
**true**
Keep the old (incorrect) behaviour that 'additionalProperties' is set to false by default.
|true|
|generateSourceCodeOnly|Specifies that only a library source code is to be generated.| |false|
|hideGenerationTimestamp|Hides the generation timestamp when files are generated.| |true|
-|library|library template (sub-template) to use: asyncio, tornado (deprecated), urllib3| |urllib3|
+|lazyImports|Enable lazy imports.| |false|
+|library|library template (sub-template) to use: asyncio, tornado (deprecated), urllib3, httpx| |urllib3|
|mapNumberTo|Map number to Union[StrictFloat, StrictInt], StrictStr or float.| |Union[StrictFloat, StrictInt]|
|packageName|python package name (convention: snake_case).| |openapi_client|
|packageUrl|python package URL.| |null|
@@ -52,6 +53,7 @@ These options may be applied as additional-properties (cli) or configOptions (pl
Dict
List
+
UUID
bool
bytearray
bytes
@@ -154,7 +156,7 @@ These options may be applied as additional-properties (cli) or configOptions (pl
|DateTime|✓|OAS2,OAS3
|Password|✓|OAS2,OAS3
|File|✓|OAS2
-|Uuid|✗|
+|Uuid|✓|
|Array|✓|OAS2,OAS3
|Null|✗|OAS3
|AnyType|✗|OAS2,OAS3
diff --git a/docs/generators/rust-axum.md b/docs/generators/rust-axum.md
index 743b58779eb3..19d87abc1240 100644
--- a/docs/generators/rust-axum.md
+++ b/docs/generators/rust-axum.md
@@ -77,6 +77,7 @@ These options may be applied as additional-properties (cli) or configOptions (pl
dyn
else
enum
+
errors
extern
false
final
@@ -207,8 +208,8 @@ These options may be applied as additional-properties (cli) or configOptions (pl
|Composite|✓|OAS2,OAS3
|Polymorphism|✗|OAS2,OAS3
|Union|✗|OAS3
-|allOf|✗|OAS2,OAS3
-|anyOf|✗|OAS3
+|allOf|✓|OAS2,OAS3
+|anyOf|✓|OAS3
|oneOf|✓|OAS3
|not|✗|OAS3
diff --git a/docs/generators/rust.md b/docs/generators/rust.md
index d3bf78829333..67f868e67af4 100644
--- a/docs/generators/rust.md
+++ b/docs/generators/rust.md
@@ -27,6 +27,7 @@ These options may be applied as additional-properties (cli) or configOptions (pl
|packageName|Rust package name (convention: lowercase).| |openapi|
|packageVersion|Rust package version.| |1.0.0|
|preferUnsignedInt|Prefer unsigned integers where minimum value is >= 0| |false|
+|reqwestDefaultFeatures|Default features for the reqwest dependency (comma-separated). Use empty for no defaults. This option is for 'reqwest' and 'reqwest-trait' library only.| |native-tls|
|supportAsync|If set, generate async function call instead. This option is for 'reqwest' library only| |true|
|supportMiddleware|If set, add support for reqwest-middleware. This option is for 'reqwest' and 'reqwest-trait' library only| |false|
|supportMultipleResponses|If set, return type wraps an enum of all possible 2xx schemas. This option is for 'reqwest' and 'reqwest-trait' library only| |false|
diff --git a/docs/generators/scala-lagom-server-deprecated.md b/docs/generators/scala-lagom-server-deprecated.md
new file mode 100644
index 000000000000..f100a8825fa2
--- /dev/null
+++ b/docs/generators/scala-lagom-server-deprecated.md
@@ -0,0 +1,255 @@
+---
+title: Documentation for the scala-lagom-server-deprecated Generator
+---
+
+## METADATA
+
+| Property | Value | Notes |
+| -------- | ----- | ----- |
+| generator name | scala-lagom-server-deprecated | pass this to the generate command after -g |
+| generator stability | DEPRECATED | |
+| generator type | SERVER | |
+| generator language | Scala | |
+| generator default templating engine | mustache | |
+| helpTxt | Generates a Lagom API server (Beta) in scala. IMPORTANT: this generator has been deprecated | |
+
+## CONFIG OPTIONS
+These options may be applied as additional-properties (cli) or configOptions (plugins). Refer to [configuration docs](https://openapi-generator.tech/docs/configuration) for more details.
+
+| Option | Description | Values | Default |
+| ------ | ----------- | ------ | ------- |
+|allowUnicodeIdentifiers|boolean, toggles whether unicode identifiers are allowed in names or not, default is false| |false|
+|apiPackage|package for generated api classes| |null|
+|dateLibrary|Option. Date library to use|
**joda**
Joda (for legacy app)
**java8**
Java 8 native JSR310 (preferred for JDK 1.8+)
|java8|
+|disallowAdditionalPropertiesIfNotPresent|If false, the 'additionalProperties' implementation (set to true by default) is compliant with the OAS and JSON schema specifications. If true (default), keep the old (incorrect) behaviour that 'additionalProperties' is set to false by default.|
**false**
The 'additionalProperties' implementation is compliant with the OAS and JSON schema specifications.
**true**
Keep the old (incorrect) behaviour that 'additionalProperties' is set to false by default.
|true|
+|ensureUniqueParams|Whether to ensure parameter names are unique in an operation (rename parameters that are not).| |true|
+|enumUnknownDefaultCase|If the server adds new enum cases, that are unknown by an old spec/client, the client will fail to parse the network response.With this option enabled, each enum will have a new case, 'unknown_default_open_api', so that when the server sends an enum case that is not known by the client/spec, they can safely fallback to this case.|
**false**
No changes to the enum's are made, this is the default option.
**true**
With this option enabled, each enum will have a new case, 'unknown_default_open_api', so that when the enum case sent by the server is not known by the client/spec, can safely be decoded to this case.
|false|
+|legacyDiscriminatorBehavior|Set to false for generators with better support for discriminators. (Python, Java, Go, PowerShell, C# have this enabled by default).|
**true**
The mapping in the discriminator includes descendent schemas that allOf inherit from self and the discriminator mapping schemas in the OAS document.
**false**
The mapping in the discriminator includes any descendent schemas that allOf inherit from self, any oneOf schemas, any anyOf schemas, any x-discriminator-values, and the discriminator mapping schemas in the OAS document AND Codegen validates that oneOf and anyOf schemas contain the required discriminator and throws an error if the discriminator is missing.
|true|
+|modelPackage|package for generated models| |null|
+|modelPropertyNaming|Naming convention for the property: 'camelCase', 'PascalCase', 'snake_case' and 'original', which keeps the original name| |camelCase|
+|prependFormOrBodyParameters|Add form or body parameters to the beginning of the parameter list.| |false|
+|sortModelPropertiesByRequiredFlag|Sort model properties to place required parameters before optional parameters.| |true|
+|sortParamsByRequiredFlag|Sort method arguments to place required parameters before optional parameters.| |true|
+|sourceFolder|source folder for generated code| |null|
+
+## IMPORT MAPPING
+
+| Type/Alias | Imports |
+| ---------- | ------- |
+|Array|java.util.List|
+|ArrayList|java.util.ArrayList|
+|Date|java.util.Date|
+|DateTime|org.joda.time.DateTime|
+|File|java.io.File|
+|HashMap|java.util.HashMap|
+|ListBuffer|scala.collection.mutable.ListBuffer|
+|ListSet|scala.collection.immutable.ListSet|
+|LocalDate|org.joda.time.*|
+|LocalDateTime|org.joda.time.*|
+|LocalTime|org.joda.time.*|
+|Seq|scala.collection.immutable.Seq|
+|Timestamp|java.sql.Timestamp|
+|URI|java.net.URI|
+|UUID|java.util.UUID|
+
+
+## INSTANTIATION TYPES
+
+| Type/Alias | Instantiated By |
+| ---------- | --------------- |
+|array|ListBuffer|
+|map|HashMap|
+|set|Set|
+
+
+## LANGUAGE PRIMITIVES
+
+
+
Any
+
Array
+
Boolean
+
Byte
+
Double
+
Float
+
Int
+
List
+
Long
+
Map
+
Object
+
Seq
+
String
+
boolean
+
+
+## RESERVED WORDS
+
+
+
abstract
+
apiinvoker
+
basepath
+
case
+
catch
+
class
+
contenttype
+
contenttypes
+
def
+
do
+
else
+
extends
+
false
+
final
+
finally
+
for
+
formparams
+
forsome
+
headerparams
+
if
+
implicit
+
import
+
lazy
+
match
+
mp
+
new
+
null
+
object
+
override
+
package
+
path
+
postbody
+
private
+
protected
+
queryparams
+
return
+
sealed
+
super
+
this
+
throw
+
trait
+
true
+
try
+
type
+
val
+
var
+
while
+
with
+
yield
+
+
+## FEATURE SET
+
+
+### Client Modification Feature
+| Name | Supported | Defined By |
+| ---- | --------- | ---------- |
+|BasePath|✗|ToolingExtension
+|Authorizations|✗|ToolingExtension
+|UserAgent|✗|ToolingExtension
+|MockServer|✗|ToolingExtension
+
+### Data Type Feature
+| Name | Supported | Defined By |
+| ---- | --------- | ---------- |
+|Custom|✗|OAS2,OAS3
+|Int32|✓|OAS2,OAS3
+|Int64|✓|OAS2,OAS3
+|Float|✓|OAS2,OAS3
+|Double|✓|OAS2,OAS3
+|Decimal|✓|ToolingExtension
+|String|✓|OAS2,OAS3
+|Byte|✓|OAS2,OAS3
+|Binary|✓|OAS2,OAS3
+|Boolean|✓|OAS2,OAS3
+|Date|✓|OAS2,OAS3
+|DateTime|✓|OAS2,OAS3
+|Password|✓|OAS2,OAS3
+|File|✓|OAS2
+|Uuid|✗|
+|Array|✓|OAS2,OAS3
+|Null|✗|OAS3
+|AnyType|✗|OAS2,OAS3
+|Object|✓|OAS2,OAS3
+|Maps|✓|ToolingExtension
+|CollectionFormat|✓|OAS2
+|CollectionFormatMulti|✓|OAS2
+|Enum|✓|OAS2,OAS3
+|ArrayOfEnum|✓|ToolingExtension
+|ArrayOfModel|✓|ToolingExtension
+|ArrayOfCollectionOfPrimitives|✓|ToolingExtension
+|ArrayOfCollectionOfModel|✓|ToolingExtension
+|ArrayOfCollectionOfEnum|✓|ToolingExtension
+|MapOfEnum|✓|ToolingExtension
+|MapOfModel|✓|ToolingExtension
+|MapOfCollectionOfPrimitives|✓|ToolingExtension
+|MapOfCollectionOfModel|✓|ToolingExtension
+|MapOfCollectionOfEnum|✓|ToolingExtension
+
+### Documentation Feature
+| Name | Supported | Defined By |
+| ---- | --------- | ---------- |
+|Readme|✓|ToolingExtension
+|Model|✓|ToolingExtension
+|Api|✓|ToolingExtension
+
+### Global Feature
+| Name | Supported | Defined By |
+| ---- | --------- | ---------- |
+|Host|✓|OAS2,OAS3
+|BasePath|✓|OAS2,OAS3
+|Info|✓|OAS2,OAS3
+|Schemes|✗|OAS2,OAS3
+|PartialSchemes|✓|OAS2,OAS3
+|Consumes|✓|OAS2
+|Produces|✓|OAS2
+|ExternalDocumentation|✓|OAS2,OAS3
+|Examples|✓|OAS2,OAS3
+|XMLStructureDefinitions|✗|OAS2,OAS3
+|MultiServer|✗|OAS3
+|ParameterizedServer|✗|OAS3
+|ParameterStyling|✗|OAS3
+|Callbacks|✗|OAS3
+|LinkObjects|✗|OAS3
+
+### Parameter Feature
+| Name | Supported | Defined By |
+| ---- | --------- | ---------- |
+|Path|✓|OAS2,OAS3
+|Query|✓|OAS2,OAS3
+|Header|✓|OAS2,OAS3
+|Body|✓|OAS2
+|FormUnencoded|✓|OAS2
+|FormMultipart|✓|OAS2
+|Cookie|✗|OAS3
+
+### Schema Support Feature
+| Name | Supported | Defined By |
+| ---- | --------- | ---------- |
+|Simple|✓|OAS2,OAS3
+|Composite|✓|OAS2,OAS3
+|Polymorphism|✗|OAS2,OAS3
+|Union|✗|OAS3
+|allOf|✗|OAS2,OAS3
+|anyOf|✗|OAS3
+|oneOf|✗|OAS3
+|not|✗|OAS3
+
+### Security Feature
+| Name | Supported | Defined By |
+| ---- | --------- | ---------- |
+|BasicAuth|✗|OAS2,OAS3
+|ApiKey|✗|OAS2,OAS3
+|OpenIDConnect|✗|OAS3
+|BearerToken|✗|OAS3
+|OAuth2_Implicit|✗|OAS2,OAS3
+|OAuth2_Password|✗|OAS2,OAS3
+|OAuth2_ClientCredentials|✗|OAS2,OAS3
+|OAuth2_AuthorizationCode|✗|OAS2,OAS3
+|SignatureAuth|✗|OAS3
+|AWSV4Signature|✗|ToolingExtension
+
+### Wire Format Feature
+| Name | Supported | Defined By |
+| ---- | --------- | ---------- |
+|JSON|✓|OAS2,OAS3
+|XML|✓|OAS2,OAS3
+|PROTOBUF|✗|ToolingExtension
+|Custom|✓|OAS2,OAS3
diff --git a/docs/generators/scala-lagom-server.md b/docs/generators/scala-lagom-server.md
deleted file mode 100644
index 2261851ca503..000000000000
--- a/docs/generators/scala-lagom-server.md
+++ /dev/null
@@ -1,255 +0,0 @@
----
-title: Documentation for the scala-lagom-server Generator
----
-
-## METADATA
-
-| Property | Value | Notes |
-| -------- | ----- | ----- |
-| generator name | scala-lagom-server | pass this to the generate command after -g |
-| generator stability | STABLE | |
-| generator type | SERVER | |
-| generator language | Scala | |
-| generator default templating engine | mustache | |
-| helpTxt | Generates a Lagom API server (Beta) in scala | |
-
-## CONFIG OPTIONS
-These options may be applied as additional-properties (cli) or configOptions (plugins). Refer to [configuration docs](https://openapi-generator.tech/docs/configuration) for more details.
-
-| Option | Description | Values | Default |
-| ------ | ----------- | ------ | ------- |
-|allowUnicodeIdentifiers|boolean, toggles whether unicode identifiers are allowed in names or not, default is false| |false|
-|apiPackage|package for generated api classes| |null|
-|dateLibrary|Option. Date library to use|
**joda**
Joda (for legacy app)
**java8**
Java 8 native JSR310 (preferred for JDK 1.8+)
|java8|
-|disallowAdditionalPropertiesIfNotPresent|If false, the 'additionalProperties' implementation (set to true by default) is compliant with the OAS and JSON schema specifications. If true (default), keep the old (incorrect) behaviour that 'additionalProperties' is set to false by default.|
**false**
The 'additionalProperties' implementation is compliant with the OAS and JSON schema specifications.
**true**
Keep the old (incorrect) behaviour that 'additionalProperties' is set to false by default.
|true|
-|ensureUniqueParams|Whether to ensure parameter names are unique in an operation (rename parameters that are not).| |true|
-|enumUnknownDefaultCase|If the server adds new enum cases, that are unknown by an old spec/client, the client will fail to parse the network response.With this option enabled, each enum will have a new case, 'unknown_default_open_api', so that when the server sends an enum case that is not known by the client/spec, they can safely fallback to this case.|
**false**
No changes to the enum's are made, this is the default option.
**true**
With this option enabled, each enum will have a new case, 'unknown_default_open_api', so that when the enum case sent by the server is not known by the client/spec, can safely be decoded to this case.
|false|
-|legacyDiscriminatorBehavior|Set to false for generators with better support for discriminators. (Python, Java, Go, PowerShell, C# have this enabled by default).|
**true**
The mapping in the discriminator includes descendent schemas that allOf inherit from self and the discriminator mapping schemas in the OAS document.
**false**
The mapping in the discriminator includes any descendent schemas that allOf inherit from self, any oneOf schemas, any anyOf schemas, any x-discriminator-values, and the discriminator mapping schemas in the OAS document AND Codegen validates that oneOf and anyOf schemas contain the required discriminator and throws an error if the discriminator is missing.
|true|
-|modelPackage|package for generated models| |null|
-|modelPropertyNaming|Naming convention for the property: 'camelCase', 'PascalCase', 'snake_case' and 'original', which keeps the original name| |camelCase|
-|prependFormOrBodyParameters|Add form or body parameters to the beginning of the parameter list.| |false|
-|sortModelPropertiesByRequiredFlag|Sort model properties to place required parameters before optional parameters.| |true|
-|sortParamsByRequiredFlag|Sort method arguments to place required parameters before optional parameters.| |true|
-|sourceFolder|source folder for generated code| |null|
-
-## IMPORT MAPPING
-
-| Type/Alias | Imports |
-| ---------- | ------- |
-|Array|java.util.List|
-|ArrayList|java.util.ArrayList|
-|Date|java.util.Date|
-|DateTime|org.joda.time.DateTime|
-|File|java.io.File|
-|HashMap|java.util.HashMap|
-|ListBuffer|scala.collection.mutable.ListBuffer|
-|ListSet|scala.collection.immutable.ListSet|
-|LocalDate|org.joda.time.*|
-|LocalDateTime|org.joda.time.*|
-|LocalTime|org.joda.time.*|
-|Seq|scala.collection.immutable.Seq|
-|Timestamp|java.sql.Timestamp|
-|URI|java.net.URI|
-|UUID|java.util.UUID|
-
-
-## INSTANTIATION TYPES
-
-| Type/Alias | Instantiated By |
-| ---------- | --------------- |
-|array|ListBuffer|
-|map|HashMap|
-|set|Set|
-
-
-## LANGUAGE PRIMITIVES
-
-
-
Any
-
Array
-
Boolean
-
Byte
-
Double
-
Float
-
Int
-
List
-
Long
-
Map
-
Object
-
Seq
-
String
-
boolean
-
-
-## RESERVED WORDS
-
-
-
abstract
-
apiinvoker
-
basepath
-
case
-
catch
-
class
-
contenttype
-
contenttypes
-
def
-
do
-
else
-
extends
-
false
-
final
-
finally
-
for
-
formparams
-
forsome
-
headerparams
-
if
-
implicit
-
import
-
lazy
-
match
-
mp
-
new
-
null
-
object
-
override
-
package
-
path
-
postbody
-
private
-
protected
-
queryparams
-
return
-
sealed
-
super
-
this
-
throw
-
trait
-
true
-
try
-
type
-
val
-
var
-
while
-
with
-
yield
-
-
-## FEATURE SET
-
-
-### Client Modification Feature
-| Name | Supported | Defined By |
-| ---- | --------- | ---------- |
-|BasePath|✗|ToolingExtension
-|Authorizations|✗|ToolingExtension
-|UserAgent|✗|ToolingExtension
-|MockServer|✗|ToolingExtension
-
-### Data Type Feature
-| Name | Supported | Defined By |
-| ---- | --------- | ---------- |
-|Custom|✗|OAS2,OAS3
-|Int32|✓|OAS2,OAS3
-|Int64|✓|OAS2,OAS3
-|Float|✓|OAS2,OAS3
-|Double|✓|OAS2,OAS3
-|Decimal|✓|ToolingExtension
-|String|✓|OAS2,OAS3
-|Byte|✓|OAS2,OAS3
-|Binary|✓|OAS2,OAS3
-|Boolean|✓|OAS2,OAS3
-|Date|✓|OAS2,OAS3
-|DateTime|✓|OAS2,OAS3
-|Password|✓|OAS2,OAS3
-|File|✓|OAS2
-|Uuid|✗|
-|Array|✓|OAS2,OAS3
-|Null|✗|OAS3
-|AnyType|✗|OAS2,OAS3
-|Object|✓|OAS2,OAS3
-|Maps|✓|ToolingExtension
-|CollectionFormat|✓|OAS2
-|CollectionFormatMulti|✓|OAS2
-|Enum|✓|OAS2,OAS3
-|ArrayOfEnum|✓|ToolingExtension
-|ArrayOfModel|✓|ToolingExtension
-|ArrayOfCollectionOfPrimitives|✓|ToolingExtension
-|ArrayOfCollectionOfModel|✓|ToolingExtension
-|ArrayOfCollectionOfEnum|✓|ToolingExtension
-|MapOfEnum|✓|ToolingExtension
-|MapOfModel|✓|ToolingExtension
-|MapOfCollectionOfPrimitives|✓|ToolingExtension
-|MapOfCollectionOfModel|✓|ToolingExtension
-|MapOfCollectionOfEnum|✓|ToolingExtension
-
-### Documentation Feature
-| Name | Supported | Defined By |
-| ---- | --------- | ---------- |
-|Readme|✓|ToolingExtension
-|Model|✓|ToolingExtension
-|Api|✓|ToolingExtension
-
-### Global Feature
-| Name | Supported | Defined By |
-| ---- | --------- | ---------- |
-|Host|✓|OAS2,OAS3
-|BasePath|✓|OAS2,OAS3
-|Info|✓|OAS2,OAS3
-|Schemes|✗|OAS2,OAS3
-|PartialSchemes|✓|OAS2,OAS3
-|Consumes|✓|OAS2
-|Produces|✓|OAS2
-|ExternalDocumentation|✓|OAS2,OAS3
-|Examples|✓|OAS2,OAS3
-|XMLStructureDefinitions|✗|OAS2,OAS3
-|MultiServer|✗|OAS3
-|ParameterizedServer|✗|OAS3
-|ParameterStyling|✗|OAS3
-|Callbacks|✗|OAS3
-|LinkObjects|✗|OAS3
-
-### Parameter Feature
-| Name | Supported | Defined By |
-| ---- | --------- | ---------- |
-|Path|✓|OAS2,OAS3
-|Query|✓|OAS2,OAS3
-|Header|✓|OAS2,OAS3
-|Body|✓|OAS2
-|FormUnencoded|✓|OAS2
-|FormMultipart|✓|OAS2
-|Cookie|✗|OAS3
-
-### Schema Support Feature
-| Name | Supported | Defined By |
-| ---- | --------- | ---------- |
-|Simple|✓|OAS2,OAS3
-|Composite|✓|OAS2,OAS3
-|Polymorphism|✗|OAS2,OAS3
-|Union|✗|OAS3
-|allOf|✗|OAS2,OAS3
-|anyOf|✗|OAS3
-|oneOf|✗|OAS3
-|not|✗|OAS3
-
-### Security Feature
-| Name | Supported | Defined By |
-| ---- | --------- | ---------- |
-|BasicAuth|✗|OAS2,OAS3
-|ApiKey|✗|OAS2,OAS3
-|OpenIDConnect|✗|OAS3
-|BearerToken|✗|OAS3
-|OAuth2_Implicit|✗|OAS2,OAS3
-|OAuth2_Password|✗|OAS2,OAS3
-|OAuth2_ClientCredentials|✗|OAS2,OAS3
-|OAuth2_AuthorizationCode|✗|OAS2,OAS3
-|SignatureAuth|✗|OAS3
-|AWSV4Signature|✗|ToolingExtension
-
-### Wire Format Feature
-| Name | Supported | Defined By |
-| ---- | --------- | ---------- |
-|JSON|✓|OAS2,OAS3
-|XML|✓|OAS2,OAS3
-|PROTOBUF|✗|ToolingExtension
-|Custom|✓|OAS2,OAS3
diff --git a/docs/generators/spring.md b/docs/generators/spring.md
index 1f8d24edb62b..2af0fe826a3e 100644
--- a/docs/generators/spring.md
+++ b/docs/generators/spring.md
@@ -88,10 +88,12 @@ 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|
|sourceFolder|source folder for generated code| |src/main/java|
+|springApiVersion|Value for 'version' attribute in @RequestMapping (for Spring 7 and above).| |null|
|testOutput|Set output folder for models and APIs tests| |${project.build.directory}/generated-test-sources/openapi|
|title|server title name or client service name| |OpenAPI Spring|
|unhandledException|Declare operation methods to throw a generic exception and allow unhandled exceptions (useful for Spring `@ControllerAdvice` directives).| |false|
|useBeanValidation|Use BeanValidation API annotations| |true|
+|useDeductionForOneOfInterfaces|whether to use deduction for generated oneOf interfaces| |false|
|useEnumCaseInsensitive|Use `equalsIgnoreCase` when String for enum comparison| |false|
|useFeignClientContextId|Whether to generate Feign client with contextId parameter.| |true|
|useFeignClientUrl|Whether to generate Feign client with url parameter.| |true|
@@ -124,6 +126,10 @@ These options may be applied as additional-properties (cli) or configOptions (pl
|x-spring-paginated|Add `org.springframework.data.domain.Pageable` to controller method. Can be used to handle `page`, `size` and `sort` query parameters. If these query parameters are also specified in the operation spec, they will be removed from the controller method as their values can be obtained from the `Pageable` object.|OPERATION|false
|x-version-param|Marker property that tells that this parameter would be used for endpoint versioning. Applicable for headers & query params. true/false|OPERATION_PARAMETER|null
|x-pattern-message|Add this property whenever you need to customize the invalidation error message for the regex pattern of a variable|FIELD, OPERATION_PARAMETER|null
+|x-size-message|Add this property whenever you need to customize the invalidation error message for the size or length of a variable|FIELD, OPERATION_PARAMETER|null
+|x-minimum-message|Add this property whenever you need to customize the invalidation error message for the minimum value of a variable|FIELD, OPERATION_PARAMETER|null
+|x-maximum-message|Add this property whenever you need to customize the invalidation error message for the maximum value of a variable|FIELD, OPERATION_PARAMETER|null
+|x-spring-api-version|Value for 'version' attribute in @RequestMapping (for Spring 7 and above).|OPERATION|null
## IMPORT MAPPING
diff --git a/docs/generators/typescript-axios.md b/docs/generators/typescript-axios.md
index 66df7b84a90d..269c2b09587e 100644
--- a/docs/generators/typescript-axios.md
+++ b/docs/generators/typescript-axios.md
@@ -44,6 +44,7 @@ These options may be applied as additional-properties (cli) or configOptions (pl
|supportsES6|Generate code that conforms to ES6.| |false|
|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|
|useSquareBracketsInArrayNames|Setting this property to true will add brackets to array attribute names, e.g. my_values[].| |false|
+|withAWSV4Signature|whether to include AWS v4 signature support| |false|
|withInterfaces|Setting this property to true will generate interfaces next to the default class implementations.| |false|
|withNodeImports|Setting this property to true adds imports for NodeJS| |false|
|withSeparateModelsAndApi|Put the model and api in separate folders and in separate classes. This requires in addition a value for 'apiPackage' and 'modelPackage'| |false|
@@ -291,7 +292,7 @@ These options may be applied as additional-properties (cli) or configOptions (pl
|OAuth2_ClientCredentials|✗|OAS2,OAS3
|OAuth2_AuthorizationCode|✗|OAS2,OAS3
|SignatureAuth|✗|OAS3
-|AWSV4Signature|✗|ToolingExtension
+|AWSV4Signature|✓|ToolingExtension
### Wire Format Feature
| Name | Supported | Defined By |
diff --git a/docs/installation.md b/docs/installation.md
index 73be5773329f..227c0f8084b5 100644
--- a/docs/installation.md
+++ b/docs/installation.md
@@ -22,7 +22,7 @@ npm install @openapitools/openapi-generator-cli -g
To install a specific version of the tool, pass the version during installation:
```bash
-openapi-generator-cli version-manager set 7.15.0
+openapi-generator-cli version-manager set 7.17.0
```
To install the tool as a dev dependency in your current project:
@@ -119,18 +119,18 @@ docker run --rm \
If you're looking for the latest stable version, you can grab it directly from Maven.org (Java 11 runtime at a minimum):
-JAR location: `https://repo1.maven.org/maven2/org/openapitools/openapi-generator-cli/7.15.0/openapi-generator-cli-7.15.0.jar`
+JAR location: `https://repo1.maven.org/maven2/org/openapitools/openapi-generator-cli/7.17.0/openapi-generator-cli-7.17.0.jar`
For **Mac/Linux** users:
```bash
-wget https://repo1.maven.org/maven2/org/openapitools/openapi-generator-cli/7.15.0/openapi-generator-cli-7.15.0.jar -O openapi-generator-cli.jar
+wget https://repo1.maven.org/maven2/org/openapitools/openapi-generator-cli/7.17.0/openapi-generator-cli-7.17.0.jar -O openapi-generator-cli.jar
```
For **Windows** users, you will need to install [wget](http://gnuwin32.sourceforge.net/packages/wget.htm) or you can use Invoke-WebRequest in PowerShell (3.0+), e.g.
```powershell
-Invoke-WebRequest -OutFile openapi-generator-cli.jar https://repo1.maven.org/maven2/org/openapitools/openapi-generator-cli/7.15.0/openapi-generator-cli-7.15.0.jar
+Invoke-WebRequest -OutFile openapi-generator-cli.jar https://repo1.maven.org/maven2/org/openapitools/openapi-generator-cli/7.17.0/openapi-generator-cli-7.17.0.jar
```
diff --git a/docs/plugins.md b/docs/plugins.md
index c7a68544193d..30d54a8da756 100644
--- a/docs/plugins.md
+++ b/docs/plugins.md
@@ -16,7 +16,7 @@ Add to your `build->plugins` section (default phase is `generate-sources` phase)
org.openapitoolsopenapi-generator-maven-plugin
- 7.15.0
+ 7.17.0
diff --git a/modules/openapi-generator-cli/pom.xml b/modules/openapi-generator-cli/pom.xml
index fa08f0193633..370bfb65d969 100644
--- a/modules/openapi-generator-cli/pom.xml
+++ b/modules/openapi-generator-cli/pom.xml
@@ -4,7 +4,7 @@
org.openapitoolsopenapi-generator-project
- 7.16.0-SNAPSHOT
+ 7.18.0-SNAPSHOT../../pom.xml
diff --git a/modules/openapi-generator-cli/src/main/java/org/openapitools/codegen/cmd/GenerateBatch.java b/modules/openapi-generator-cli/src/main/java/org/openapitools/codegen/cmd/GenerateBatch.java
index 2c56b2918f94..f2823ce366d8 100644
--- a/modules/openapi-generator-cli/src/main/java/org/openapitools/codegen/cmd/GenerateBatch.java
+++ b/modules/openapi-generator-cli/src/main/java/org/openapitools/codegen/cmd/GenerateBatch.java
@@ -29,6 +29,7 @@
import io.airlift.airline.Command;
import io.airlift.airline.Option;
import org.apache.commons.io.FileUtils;
+import org.apache.commons.lang3.Strings;
import org.apache.commons.lang3.StringUtils;
import org.openapitools.codegen.ClientOptInput;
import org.openapitools.codegen.CodegenConfig;
@@ -248,7 +249,7 @@ private void cleanPreviousFiles(final String name, Path outDir) throws IOExcepti
Path filesMeta = Paths.get(outDir.toAbsolutePath().toString(), ".openapi-generator", "FILES");
if (filesMeta.toFile().exists()) {
FileUtils.readLines(filesMeta.toFile(), StandardCharsets.UTF_8).forEach(relativePath -> {
- if (!StringUtils.startsWith(relativePath, ".")) {
+ if (!Strings.CS.startsWith(relativePath, ".")) {
Path file = outDir.resolve(relativePath).toAbsolutePath();
// hack: disallow directory traversal outside of output directory. we don't want to delete wrong files.
if (file.toString().startsWith(outDir.toAbsolutePath().toString())) {
diff --git a/modules/openapi-generator-core/pom.xml b/modules/openapi-generator-core/pom.xml
index 4f0207c924e1..bd8e885a7247 100644
--- a/modules/openapi-generator-core/pom.xml
+++ b/modules/openapi-generator-core/pom.xml
@@ -6,7 +6,7 @@
openapi-generator-projectorg.openapitools
- 7.16.0-SNAPSHOT
+ 7.18.0-SNAPSHOT../../pom.xml
diff --git a/modules/openapi-generator-gradle-plugin/README.adoc b/modules/openapi-generator-gradle-plugin/README.adoc
index 08d2187aad0a..f70323f85041 100644
--- a/modules/openapi-generator-gradle-plugin/README.adoc
+++ b/modules/openapi-generator-gradle-plugin/README.adoc
@@ -97,7 +97,7 @@ task validateGoodSpec(type: org.openapitools.generator.gradle.plugin.tasks.Valid
[source,group]
----
plugins {
- id "org.openapi.generator" version "7.15.0"
+ id "org.openapi.generator" version "7.17.0"
}
----
@@ -113,7 +113,7 @@ buildscript {
// url "https://plugins.gradle.org/m2/"
}
dependencies {
- classpath "org.openapitools:openapi-generator-gradle-plugin:7.15.0"
+ classpath "org.openapitools:openapi-generator-gradle-plugin:7.17.0"
}
}
@@ -759,7 +759,7 @@ buildscript {
}
dependencies {
classpath 'com.android.tools.build:gradle:3.2.1'
- classpath('org.openapitools:openapi-generator-gradle-plugin:7.15.0') {
+ classpath('org.openapitools:openapi-generator-gradle-plugin:7.17.0') {
exclude group: 'com.google.guava'
}
}
diff --git a/modules/openapi-generator-gradle-plugin/build.gradle b/modules/openapi-generator-gradle-plugin/build.gradle
index 90bf9dcc8d1e..5bfe8171199d 100644
--- a/modules/openapi-generator-gradle-plugin/build.gradle
+++ b/modules/openapi-generator-gradle-plugin/build.gradle
@@ -81,6 +81,10 @@ tasks.withType(ReleaseNexusStagingRepository).configureEach {
onlyIf { nexusPublishing.useStaging.get() }
}
+tasks.named("validatePlugins").configure {
+ enableStricterValidation = true
+}
+
gradlePlugin {
website = "https://openapi-generator.tech/"
vcsUrl = "https://github.com/OpenAPITools/openapi-generator"
diff --git a/modules/openapi-generator-gradle-plugin/gradle.properties b/modules/openapi-generator-gradle-plugin/gradle.properties
index 34e355455e13..658037ab501b 100644
--- a/modules/openapi-generator-gradle-plugin/gradle.properties
+++ b/modules/openapi-generator-gradle-plugin/gradle.properties
@@ -1,5 +1,5 @@
# RELEASE_VERSION
-openApiGeneratorVersion=7.16.0-SNAPSHOT
+openApiGeneratorVersion=7.18.0-SNAPSHOT
# /RELEASE_VERSION
# BEGIN placeholders
diff --git a/modules/openapi-generator-gradle-plugin/pom.xml b/modules/openapi-generator-gradle-plugin/pom.xml
index 22b4c4dce091..b2486d48eca5 100644
--- a/modules/openapi-generator-gradle-plugin/pom.xml
+++ b/modules/openapi-generator-gradle-plugin/pom.xml
@@ -4,7 +4,7 @@
org.openapitoolsopenapi-generator-project
- 7.16.0-SNAPSHOT
+ 7.18.0-SNAPSHOT../../pom.xml
diff --git a/modules/openapi-generator-gradle-plugin/samples/local-spec/README.md b/modules/openapi-generator-gradle-plugin/samples/local-spec/README.md
index c26b59fa88c1..4c0d6138ca75 100644
--- a/modules/openapi-generator-gradle-plugin/samples/local-spec/README.md
+++ b/modules/openapi-generator-gradle-plugin/samples/local-spec/README.md
@@ -19,5 +19,5 @@ gradle generateGoWithInvalidSpec # expected outcome: BUILD FAILED
The samples can be tested against other versions of the plugin using the `openApiGeneratorVersion` property. For example:
```bash
-gradle -PopenApiGeneratorVersion=7.15.0 openApiValidate
+gradle -PopenApiGeneratorVersion=7.17.0 openApiValidate
```
diff --git a/modules/openapi-generator-gradle-plugin/samples/local-spec/gradle.properties b/modules/openapi-generator-gradle-plugin/samples/local-spec/gradle.properties
index 648c1c752cec..5dc0eb2ff4ba 100644
--- a/modules/openapi-generator-gradle-plugin/samples/local-spec/gradle.properties
+++ b/modules/openapi-generator-gradle-plugin/samples/local-spec/gradle.properties
@@ -1,3 +1,3 @@
# RELEASE_VERSION
-openApiGeneratorVersion=7.16.0-SNAPSHOT
+openApiGeneratorVersion=7.18.0-SNAPSHOT
# /RELEASE_VERSION
diff --git a/modules/openapi-generator-gradle-plugin/src/main/kotlin/org/openapitools/generator/gradle/plugin/extensions/OpenApiGeneratorGenerateExtension.kt b/modules/openapi-generator-gradle-plugin/src/main/kotlin/org/openapitools/generator/gradle/plugin/extensions/OpenApiGeneratorGenerateExtension.kt
index 8d7d31d5d1fb..3d5a3489cf01 100644
--- a/modules/openapi-generator-gradle-plugin/src/main/kotlin/org/openapitools/generator/gradle/plugin/extensions/OpenApiGeneratorGenerateExtension.kt
+++ b/modules/openapi-generator-gradle-plugin/src/main/kotlin/org/openapitools/generator/gradle/plugin/extensions/OpenApiGeneratorGenerateExtension.kt
@@ -81,12 +81,12 @@ open class OpenApiGeneratorGenerateExtension(project: Project) {
/**
* The template directory holding a custom template.
*/
- val templateDir = project.objects.property()
+ val templateDir = project.objects.property()
/**
* The template location (which may be a directory or a classpath location) holding custom templates.
*/
- val templateResourcePath = project.objects.property()
+ val templateResourcePath = project.objects.property()
/**
* Adds authorization headers when fetching the OpenAPI definitions remotely.
@@ -109,7 +109,7 @@ open class OpenApiGeneratorGenerateExtension(project: Project) {
/**
* Specifies if the existing files should be overwritten during the generation.
*/
- val skipOverwrite = project.objects.property()
+ val skipOverwrite = project.objects.property()
/**
* Package for generated classes (where supported)
@@ -244,32 +244,32 @@ open class OpenApiGeneratorGenerateExtension(project: Project) {
/**
* Reference the library template (sub-template) of a generator.
*/
- val library = project.objects.property()
+ val library = project.objects.property()
/**
* Git host, e.g. gitlab.com.
*/
- val gitHost = project.objects.property()
+ val gitHost = project.objects.property()
/**
* Git user ID, e.g. openapitools.
*/
- val gitUserId = project.objects.property()
+ val gitUserId = project.objects.property()
/**
* Git repo ID, e.g. openapi-generator.
*/
- val gitRepoId = project.objects.property()
+ val gitRepoId = project.objects.property()
/**
* Release note, default to 'Minor update'.
*/
- val releaseNote = project.objects.property()
+ val releaseNote = project.objects.property()
/**
* HTTP user agent, e.g. codegen_csharp_api_client, default to 'OpenAPI-Generator/{packageVersion}/{language}'
*/
- val httpUserAgent = project.objects.property()
+ val httpUserAgent = project.objects.property()
/**
* Specifies how a reserved name should be escaped to. Otherwise, the default _ is used.
@@ -279,17 +279,17 @@ open class OpenApiGeneratorGenerateExtension(project: Project) {
/**
* Specifies an override location for the .openapi-generator-ignore file. Most useful on initial generation.
*/
- val ignoreFileOverride = project.objects.property()
+ val ignoreFileOverride = project.objects.property()
/**
* Remove prefix of operationId, e.g. config_getId => getId
*/
- val removeOperationIdPrefix = project.objects.property()
+ val removeOperationIdPrefix = project.objects.property()
/**
* Skip examples defined in the operation
*/
- val skipOperationExample = project.objects.property()
+ val skipOperationExample = project.objects.property()
/**
* Defines which API-related files should be generated. This allows you to create a subset of generated files (or none at all).
@@ -394,7 +394,7 @@ open class OpenApiGeneratorGenerateExtension(project: Project) {
/**
* Templating engine: "mustache" (default) or "handlebars" (beta)
*/
- val engine = project.objects.property()
+ val engine = project.objects.property()
/**
* Defines whether the output dir should be cleaned up before generating the output.
diff --git a/modules/openapi-generator-gradle-plugin/src/main/kotlin/org/openapitools/generator/gradle/plugin/tasks/GenerateTask.kt b/modules/openapi-generator-gradle-plugin/src/main/kotlin/org/openapitools/generator/gradle/plugin/tasks/GenerateTask.kt
index 8da6bc79b0b7..61b66a1d409a 100644
--- a/modules/openapi-generator-gradle-plugin/src/main/kotlin/org/openapitools/generator/gradle/plugin/tasks/GenerateTask.kt
+++ b/modules/openapi-generator-gradle-plugin/src/main/kotlin/org/openapitools/generator/gradle/plugin/tasks/GenerateTask.kt
@@ -55,50 +55,49 @@ import org.openapitools.codegen.config.MergedSpecBuilder
*
* @author Jim Schubert
*/
-@Suppress("UnstableApiUsage")
@CacheableTask
open class GenerateTask @Inject constructor(private val objectFactory: ObjectFactory) : DefaultTask() {
/**
* The verbosity of generation
*/
- @Optional
- @Input
+ @get:Optional
+ @get:Input
val verbose = project.objects.property()
/**
* Whether an input specification should be validated upon generation.
*/
- @Optional
- @Input
+ @get:Optional
+ @get:Input
val validateSpec = project.objects.property()
/**
* The name of the generator which will handle codegen. (see "openApiGenerators" task)
*/
- @Optional
- @Input
+ @get:Optional
+ @get:Input
val generatorName = project.objects.property()
/**
* This is the configuration for reference paths where schemas for openapi generation are stored
* The directory which contains the additional schema files
*/
- @Optional
- @InputDirectory
- @PathSensitive(PathSensitivity.ABSOLUTE)
+ @get:Optional
+ @get:InputDirectory
+ @get:PathSensitive(PathSensitivity.ABSOLUTE)
val schemaLocation = project.objects.property()
/**
* The output target directory into which code will be generated.
*/
- @Optional
+ @get:Optional
@get:OutputDirectory
val outputDir = project.objects.property()
@Suppress("unused")
@set:Option(option = "input", description = "The input specification.")
- @Internal
+ @get:Internal
var input: String? = null
set(value) {
inputSpec.set(value)
@@ -111,9 +110,9 @@ open class GenerateTask @Inject constructor(private val objectFactory: ObjectFac
* changes to any $ref referenced files. Use the `inputSpecRootDirectory` property to have Gradle track changes to
* an entire directory of spec files.
*/
- @Optional
+ @get:Optional
@get:InputFile
- @PathSensitive(PathSensitivity.RELATIVE)
+ @get:PathSensitive(PathSensitivity.RELATIVE)
val inputSpec = project.objects.property()
/**
@@ -122,60 +121,60 @@ open class GenerateTask @Inject constructor(private val objectFactory: ObjectFac
* By default, a merged spec file will be generated based on the contents of the directory. To disable this, set the
* `inputSpecRootDirectorySkipMerge` property.
*/
- @Optional
+ @get:Optional
@get:InputDirectory
- @PathSensitive(PathSensitivity.RELATIVE)
+ @get:PathSensitive(PathSensitivity.RELATIVE)
val inputSpecRootDirectory = project.objects.property();
/**
* Skip bundling all spec files into a merged spec file, if true.
*/
- @Input
- @Optional
+ @get:Input
+ @get:Optional
val inputSpecRootDirectorySkipMerge = project.objects.property()
/**
* Name of the file that will contain all merged specs
*/
- @Input
- @Optional
+ @get:Input
+ @get:Optional
val mergedFileName = project.objects.property();
/**
* The remote Open API 2.0/3.x specification URL location.
*/
- @Input
- @Optional
+ @get:Input
+ @get:Optional
val remoteInputSpec = project.objects.property()
/**
* The template directory holding a custom template.
*/
- @Optional
- @InputDirectory
- @PathSensitive(PathSensitivity.RELATIVE)
- val templateDir = project.objects.property()
+ @get:Optional
+ @get:InputDirectory
+ @get:PathSensitive(PathSensitivity.RELATIVE)
+ val templateDir = project.objects.property()
/**
* Resource path containing template files.
*/
- @Optional
- @Input
- val templateResourcePath = project.objects.property()
+ @get:Optional
+ @get:Input
+ val templateResourcePath = project.objects.property()
/**
* Adds authorization headers when fetching the OpenAPI definitions remotely.
* Pass in a URL-encoded string of name:header with a comma separating multiple values
*/
- @Optional
- @Input
+ @get:Optional
+ @get:Input
val auth = project.objects.property()
/**
* Sets specified global properties.
*/
- @Optional
- @Input
+ @get:Optional
+ @get:Input
val globalProperties = project.objects.mapProperty()
/**
@@ -183,272 +182,272 @@ open class GenerateTask @Inject constructor(private val objectFactory: ObjectFac
* File content should be in a json format { "optionKey":"optionValue", "optionKey1":"optionValue1"...}
* Supported options can be different for each language. Run config-help -g {generator name} command for language specific config options.
*/
- @Optional
- @InputFile
- @PathSensitive(PathSensitivity.RELATIVE)
+ @get:Optional
+ @get:InputFile
+ @get:PathSensitive(PathSensitivity.RELATIVE)
val configFile = project.objects.property()
/**
* Specifies if the existing files should be overwritten during the generation.
*/
- @Optional
- @Input
- val skipOverwrite = project.objects.property()
+ @get:Optional
+ @get:Input
+ val skipOverwrite = project.objects.property()
/**
* Package for generated classes (where supported)
*/
- @Optional
- @Input
+ @get:Optional
+ @get:Input
val packageName = project.objects.property()
/**
* Package for generated api classes
*/
- @Optional
- @Input
+ @get:Optional
+ @get:Input
val apiPackage = project.objects.property()
/**
* Package for generated models
*/
- @Optional
- @Input
+ @get:Optional
+ @get:Input
val modelPackage = project.objects.property()
/**
* Prefix that will be prepended to all model names. Default is the empty string.
*/
- @Optional
- @Input
+ @get:Optional
+ @get:Input
val modelNamePrefix = project.objects.property()
/**
* Suffix that will be appended to all model names. Default is the empty string.
*/
- @Optional
- @Input
+ @get:Optional
+ @get:Input
val modelNameSuffix = project.objects.property()
/**
* Suffix that will be appended to all api names. Default is the empty string.
*/
- @Optional
- @Input
+ @get:Optional
+ @get:Input
val apiNameSuffix = project.objects.property()
/**
* Sets instantiation type mappings.
*/
- @Optional
- @Input
+ @get:Optional
+ @get:Input
val instantiationTypes = project.objects.mapProperty()
/**
* Sets mappings between OpenAPI spec types and generated code types.
*/
- @Optional
- @Input
+ @get:Optional
+ @get:Input
val typeMappings = project.objects.mapProperty()
/**
* Sets additional properties that can be referenced by the mustache templates in the format of name=value,name=value.
* You can also have multiple occurrences of this option.
*/
- @Optional
- @Input
+ @get:Optional
+ @get:Input
val additionalProperties = project.objects.mapProperty()
/**
* Sets server variable for server URL template substitution, in the format of name=value,name=value.
* You can also have multiple occurrences of this option.
*/
- @Optional
- @Input
+ @get:Optional
+ @get:Input
val serverVariables = project.objects.mapProperty()
/**
* Specifies additional language specific primitive types in the format of type1,type2,type3,type3. For example: String,boolean,Boolean,Double.
*/
- @Optional
- @Input
+ @get:Optional
+ @get:Input
val languageSpecificPrimitives = project.objects.listProperty()
/**
* Specifies .openapi-generator-ignore list in the form of relative/path/to/file1,relative/path/to/file2. For example: README.md,pom.xml.
*/
- @Optional
- @Input
+ @get:Optional
+ @get:Input
val openapiGeneratorIgnoreList = project.objects.listProperty()
/**
* Specifies mappings between a given class and the import that should be used for that class.
*/
- @Optional
- @Input
+ @get:Optional
+ @get:Input
val importMappings = project.objects.mapProperty()
/**
* Specifies mappings between a given schema and the new one.
*/
- @Optional
- @Input
+ @get:Optional
+ @get:Input
val schemaMappings = project.objects.mapProperty()
/**
* Specifies mappings between the inline scheme name and the new name
*/
- @Optional
- @Input
+ @get:Optional
+ @get:Input
val inlineSchemaNameMappings = project.objects.mapProperty()
/**
* Specifies options for inline schemas
*/
- @Optional
- @Input
+ @get:Optional
+ @get:Input
val inlineSchemaOptions = project.objects.mapProperty()
/**
* Specifies mappings between the property name and the new name
*/
- @Optional
- @Input
+ @get:Optional
+ @get:Input
val nameMappings = project.objects.mapProperty()
/**
* Specifies mappings between the parameter name and the new name
*/
- @Optional
- @Input
+ @get:Optional
+ @get:Input
val parameterNameMappings = project.objects.mapProperty()
/**
* Specifies mappings between the model name and the new name
*/
- @Optional
- @Input
+ @get:Optional
+ @get:Input
val modelNameMappings = project.objects.mapProperty()
/**
* Specifies mappings between the enum name and the new name
*/
- @Optional
- @Input
+ @get:Optional
+ @get:Input
val enumNameMappings = project.objects.mapProperty()
/**
* Specifies mappings between the operation id name and the new name
*/
- @Optional
- @Input
+ @get:Optional
+ @get:Input
val operationIdNameMappings = project.objects.mapProperty()
/**
* Specifies mappings (rules) in OpenAPI normalizer
*/
- @Optional
- @Input
+ @get:Optional
+ @get:Input
val openapiNormalizer = project.objects.mapProperty()
/**
* Root package for generated code.
*/
- @Optional
- @Input
+ @get:Optional
+ @get:Input
val invokerPackage = project.objects.property()
/**
* GroupId in generated pom.xml/build.gradle.kts or other build script. Language-specific conversions occur in non-jvm generators.
*/
- @Optional
- @Input
+ @get:Optional
+ @get:Input
val groupId = project.objects.property()
/**
* ArtifactId in generated pom.xml/build.gradle.kts or other build script. Language-specific conversions occur in non-jvm generators.
*/
- @Optional
- @Input
+ @get:Optional
+ @get:Input
val id = project.objects.property()
/**
* Artifact version in generated pom.xml/build.gradle.kts or other build script. Language-specific conversions occur in non-jvm generators.
*/
- @Optional
- @Input
+ @get:Optional
+ @get:Input
val version = project.objects.property()
/**
* Reference the library template (sub-template) of a generator.
*/
- @Optional
- @Input
- val library = project.objects.property()
+ @get:Optional
+ @get:Input
+ val library = project.objects.property()
/**
* Git host, e.g. gitlab.com.
*/
- @Optional
- @Input
- val gitHost = project.objects.property()
+ @get:Optional
+ @get:Input
+ val gitHost = project.objects.property()
/**
* Git user ID, e.g. openapitools.
*/
- @Optional
- @Input
- val gitUserId = project.objects.property()
+ @get:Optional
+ @get:Input
+ val gitUserId = project.objects.property()
/**
* Git repo ID, e.g. openapi-generator.
*/
- @Optional
- @Input
- val gitRepoId = project.objects.property()
+ @get:Optional
+ @get:Input
+ val gitRepoId = project.objects.property()
/**
* Release note, default to 'Minor update'.
*/
- @Optional
- @Input
- val releaseNote = project.objects.property()
+ @get:Optional
+ @get:Input
+ val releaseNote = project.objects.property()
/**
* HTTP user agent, e.g. codegen_csharp_api_client, default to 'OpenAPI-Generator/{packageVersion}/{language}'
*/
- @Optional
- @Input
- val httpUserAgent = project.objects.property()
+ @get:Optional
+ @get:Input
+ val httpUserAgent = project.objects.property()
/**
* Specifies how a reserved name should be escaped to.
*/
- @Optional
- @Input
+ @get:Optional
+ @get:Input
val reservedWordsMappings = project.objects.mapProperty()
/**
* Specifies an override location for the .openapi-generator-ignore file. Most useful on initial generation.
*/
- @Optional
- @InputFile
- @PathSensitive(PathSensitivity.RELATIVE)
- val ignoreFileOverride = project.objects.property()
+ @get:Optional
+ @get:InputFile
+ @get:PathSensitive(PathSensitivity.RELATIVE)
+ val ignoreFileOverride = project.objects.property()
/**
* Remove prefix of operationId, e.g. config_getId => getId
*/
- @Optional
- @Input
- val removeOperationIdPrefix = project.objects.property()
+ @get:Optional
+ @get:Input
+ val removeOperationIdPrefix = project.objects.property()
/**
* Remove examples defined in the operation
*/
- @Optional
- @Input
- val skipOperationExample = project.objects.property()
+ @get:Optional
+ @get:Input
+ val skipOperationExample = project.objects.property()
/**
* Defines which API-related files should be generated. This allows you to create a subset of generated files (or none at all).
@@ -459,8 +458,8 @@ open class GenerateTask @Inject constructor(private val objectFactory: ObjectFac
* in others being disabled. That is, OpenAPI Generator considers any one of these to define a subset of generation.
* For more control over generation of individual files, configure an ignore file and refer to it via [ignoreFileOverride].
*/
- @Optional
- @Input
+ @get:Optional
+ @get:Input
val apiFilesConstrainedTo = project.objects.listProperty()
/**
@@ -470,8 +469,8 @@ open class GenerateTask @Inject constructor(private val objectFactory: ObjectFac
* in others being disabled. That is, OpenAPI Generator considers any one of these to define a subset of generation.
* For more control over generation of individual files, configure an ignore file and refer to it via [ignoreFileOverride].
*/
- @Optional
- @Input
+ @get:Optional
+ @get:Input
val modelFilesConstrainedTo = project.objects.listProperty()
/**
@@ -484,8 +483,8 @@ open class GenerateTask @Inject constructor(private val objectFactory: ObjectFac
* in others being disabled. That is, OpenAPI Generator considers any one of these to define a subset of generation.
* For more control over generation of individual files, configure an ignore file and refer to it via [ignoreFileOverride].
*/
- @Optional
- @Input
+ @get:Optional
+ @get:Input
val supportingFilesConstrainedTo = project.objects.listProperty()
/**
@@ -496,8 +495,8 @@ open class GenerateTask @Inject constructor(private val objectFactory: ObjectFac
* For more control over generation of individual files, configure an ignore file and
* refer to it via [ignoreFileOverride].
*/
- @Optional
- @Input
+ @get:Optional
+ @get:Input
val generateModelTests = project.objects.property()
/**
@@ -508,8 +507,8 @@ open class GenerateTask @Inject constructor(private val objectFactory: ObjectFac
* For more control over generation of individual files, configure an ignore file and
* refer to it via [ignoreFileOverride].
*/
- @Optional
- @Input
+ @get:Optional
+ @get:Input
val generateModelDocumentation = project.objects.property()
/**
@@ -520,8 +519,8 @@ open class GenerateTask @Inject constructor(private val objectFactory: ObjectFac
* For more control over generation of individual files, configure an ignore file and
* refer to it via [ignoreFileOverride].
*/
- @Optional
- @Input
+ @get:Optional
+ @get:Input
val generateApiTests = project.objects.property()
/**
@@ -532,15 +531,15 @@ open class GenerateTask @Inject constructor(private val objectFactory: ObjectFac
* For more control over generation of individual files, configure an ignore file and
* refer to it via [ignoreFileOverride].
*/
- @Optional
- @Input
+ @get:Optional
+ @get:Input
val generateApiDocumentation = project.objects.property()
/**
* To write all log messages (not just errors) to STDOUT
*/
- @Optional
- @Input
+ @get:Optional
+ @get:Input
val logToStderr = project.objects.property()
/**
@@ -549,15 +548,15 @@ open class GenerateTask @Inject constructor(private val objectFactory: ObjectFac
* LANG_POST_PROCESS_FILE (e.g. GO_POST_PROCESS_FILE, SCALA_POST_PROCESS_FILE). Please open an issue if your target
* generator does not support this functionality.
*/
- @Optional
- @Input
+ @get:Optional
+ @get:Input
val enablePostProcessFile = project.objects.property()
/**
* To skip spec validation. When true, we will skip the default behavior of validating a spec before generation.
*/
- @Optional
- @Input
+ @get:Optional
+ @get:Input
val skipValidateSpec = project.objects.property()
/**
@@ -565,52 +564,44 @@ open class GenerateTask @Inject constructor(private val objectFactory: ObjectFac
* definitions generated as top-level Array-of-items, List-of-items, Map-of-items definitions.
* When true, A model representation either containing or extending the array,list,map (depending on specific generator implementation) will be generated.
*/
- @Optional
- @Input
+ @get:Optional
+ @get:Input
val generateAliasAsModel = project.objects.property()
/**
* A dynamic map of options specific to a generator.
*/
- @Optional
- @Input
+ @get:Optional
+ @get:Input
val configOptions = project.objects.mapProperty()
/**
* Templating engine: "mustache" (default) or "handlebars" (beta)
*/
- @Optional
- @Input
- val engine = project.objects.property()
+ @get:Optional
+ @get:Input
+ val engine = project.objects.property()
/**
* Defines whether the output dir should be cleaned up before generating the output.
*
*/
- @Optional
- @Input
+ @get:Optional
+ @get:Input
val cleanupOutput = project.objects.property()
/**
* Defines whether the generator should run in dry-run mode.
*/
- @Optional
- @Input
+ @get:Optional
+ @get:Input
val dryRun = project.objects.property()
- private fun Property.ifNotEmpty(block: Property.(T) -> Unit) {
+ private fun Property.ifNotEmpty(block: Property.(T) -> Unit) {
if (isPresent) {
- val item: T? = get()
- if (item != null) {
- when (get()) {
- is String -> if ((get() as String).isNotEmpty()) {
- block(get())
- }
- is String? -> if (true == (get() as String?)?.isNotEmpty()) {
- block(get())
- }
- else -> block(get())
- }
+ when (val value = get()) {
+ is String -> if (value.isNotEmpty()) block(value)
+ else -> block(value)
}
}
}
@@ -725,7 +716,7 @@ open class GenerateTask @Inject constructor(private val objectFactory: ObjectFac
}
skipOverwrite.ifNotEmpty { value ->
- configurator.setSkipOverwrite(value ?: false)
+ configurator.setSkipOverwrite(value)
}
generatorName.ifNotEmpty { value ->
@@ -820,11 +811,11 @@ open class GenerateTask @Inject constructor(private val objectFactory: ObjectFac
}
removeOperationIdPrefix.ifNotEmpty { value ->
- configurator.setRemoveOperationIdPrefix(value!!)
+ configurator.setRemoveOperationIdPrefix(value)
}
skipOperationExample.ifNotEmpty { value ->
- configurator.setSkipOperationExample(value!!)
+ configurator.setSkipOperationExample(value)
}
logToStderr.ifNotEmpty { value ->
diff --git a/modules/openapi-generator-gradle-plugin/src/main/kotlin/org/openapitools/generator/gradle/plugin/tasks/GeneratorsTask.kt b/modules/openapi-generator-gradle-plugin/src/main/kotlin/org/openapitools/generator/gradle/plugin/tasks/GeneratorsTask.kt
index 12f12ab81c8a..d83d00b5b637 100644
--- a/modules/openapi-generator-gradle-plugin/src/main/kotlin/org/openapitools/generator/gradle/plugin/tasks/GeneratorsTask.kt
+++ b/modules/openapi-generator-gradle-plugin/src/main/kotlin/org/openapitools/generator/gradle/plugin/tasks/GeneratorsTask.kt
@@ -22,6 +22,7 @@ import org.gradle.api.tasks.TaskAction
import org.gradle.internal.logging.text.StyledTextOutput
import org.gradle.internal.logging.text.StyledTextOutputFactory
import org.gradle.kotlin.dsl.listProperty
+import org.gradle.work.DisableCachingByDefault
import org.openapitools.codegen.CodegenConfigLoader
import org.openapitools.codegen.CodegenType
import org.openapitools.codegen.meta.GeneratorMetadata
@@ -36,6 +37,7 @@ import org.openapitools.codegen.meta.Stability
*
* @author Jim Schubert
*/
+@DisableCachingByDefault(because = "not worth caching")
open class GeneratorsTask : DefaultTask() {
/**
* A list of stability indexes to include (value: all,beta,stable,experimental,deprecated). Excludes deprecated by default.
diff --git a/modules/openapi-generator-gradle-plugin/src/main/kotlin/org/openapitools/generator/gradle/plugin/tasks/ValidateTask.kt b/modules/openapi-generator-gradle-plugin/src/main/kotlin/org/openapitools/generator/gradle/plugin/tasks/ValidateTask.kt
index 7852b68a2fc3..4d2d13836541 100644
--- a/modules/openapi-generator-gradle-plugin/src/main/kotlin/org/openapitools/generator/gradle/plugin/tasks/ValidateTask.kt
+++ b/modules/openapi-generator-gradle-plugin/src/main/kotlin/org/openapitools/generator/gradle/plugin/tasks/ValidateTask.kt
@@ -21,6 +21,7 @@ import io.swagger.v3.parser.core.models.ParseOptions
import org.gradle.api.DefaultTask
import org.gradle.api.GradleException
import org.gradle.api.logging.Logging
+import org.gradle.api.tasks.CacheableTask
import org.gradle.api.tasks.Input
import org.gradle.api.tasks.InputFile
import org.gradle.api.tasks.Internal
@@ -51,17 +52,18 @@ import org.openapitools.codegen.validations.oas.RuleConfiguration
*
* @author Jim Schubert
*/
+@CacheableTask
open class ValidateTask : DefaultTask() {
@get:InputFile
- @PathSensitive(PathSensitivity.RELATIVE)
+ @get:PathSensitive(PathSensitivity.RELATIVE)
val inputSpec = project.objects.property()
- @Optional
- @Input
+ @get:Optional
+ @get:Input
val recommend = project.objects.property().convention(true)
- @Optional
- @Input
+ @get:Optional
+ @get:Input
val treatWarningsAsErrors = project.objects.property().convention(false)
@get:Internal
diff --git a/modules/openapi-generator-maven-plugin/README.md b/modules/openapi-generator-maven-plugin/README.md
index c06a966ad0be..d9f47a9abae6 100644
--- a/modules/openapi-generator-maven-plugin/README.md
+++ b/modules/openapi-generator-maven-plugin/README.md
@@ -12,7 +12,7 @@ Add to your `build->plugins` section (default phase is `generate-sources` phase)
org.openapitoolsopenapi-generator-maven-plugin
- 7.15.0
+ 7.17.0
diff --git a/modules/openapi-generator-maven-plugin/examples/java-client.xml b/modules/openapi-generator-maven-plugin/examples/java-client.xml
index f544f654210a..6c84a59b55ed 100644
--- a/modules/openapi-generator-maven-plugin/examples/java-client.xml
+++ b/modules/openapi-generator-maven-plugin/examples/java-client.xml
@@ -13,7 +13,7 @@
org.openapitoolsopenapi-generator-maven-plugin
- 7.16.0-SNAPSHOT
+ 7.18.0-SNAPSHOT
@@ -217,9 +217,9 @@
UTF-82.2.162.35
- 2.17.1
- 2.17.1
- 0.2.6
+ 2.19.2
+ 2.19.2
+ 0.2.71.3.54.13.28.3.3
diff --git a/modules/openapi-generator-maven-plugin/examples/kotlin.xml b/modules/openapi-generator-maven-plugin/examples/kotlin.xml
index 4a72c6dbb624..21d9e87b3f63 100644
--- a/modules/openapi-generator-maven-plugin/examples/kotlin.xml
+++ b/modules/openapi-generator-maven-plugin/examples/kotlin.xml
@@ -15,7 +15,7 @@
org.openapitoolsopenapi-generator-maven-plugin
- 7.16.0-SNAPSHOT
+ 7.18.0-SNAPSHOT
@@ -232,8 +232,8 @@
1.5.82.27
- 2.15.2
- 0.2.0
+ 2.19.2
+ 0.2.72.71.0.04.13.2
diff --git a/modules/openapi-generator-maven-plugin/examples/multi-module/java-client/pom.xml b/modules/openapi-generator-maven-plugin/examples/multi-module/java-client/pom.xml
index 36a06db6112f..f339bb9c79b4 100644
--- a/modules/openapi-generator-maven-plugin/examples/multi-module/java-client/pom.xml
+++ b/modules/openapi-generator-maven-plugin/examples/multi-module/java-client/pom.xml
@@ -19,7 +19,7 @@
org.openapitoolsopenapi-generator-maven-plugin
- 7.16.0-SNAPSHOT
+ 7.18.0-SNAPSHOT
diff --git a/modules/openapi-generator-maven-plugin/examples/multi-module/pom.xml b/modules/openapi-generator-maven-plugin/examples/multi-module/pom.xml
index 4f31a42af364..bf8d027fd57d 100644
--- a/modules/openapi-generator-maven-plugin/examples/multi-module/pom.xml
+++ b/modules/openapi-generator-maven-plugin/examples/multi-module/pom.xml
@@ -15,8 +15,8 @@
1.5.82.35
- 2.17.1
- 0.2.1
+ 2.19.2
+ 0.2.72.71.0.05.10.2
diff --git a/modules/openapi-generator-maven-plugin/examples/non-java-invalid-spec.xml b/modules/openapi-generator-maven-plugin/examples/non-java-invalid-spec.xml
index 0a030f11e3d9..6e9d643cb24f 100644
--- a/modules/openapi-generator-maven-plugin/examples/non-java-invalid-spec.xml
+++ b/modules/openapi-generator-maven-plugin/examples/non-java-invalid-spec.xml
@@ -13,7 +13,7 @@
org.openapitoolsopenapi-generator-maven-plugin
- 7.16.0-SNAPSHOT
+ 7.18.0-SNAPSHOT
diff --git a/modules/openapi-generator-maven-plugin/examples/non-java.xml b/modules/openapi-generator-maven-plugin/examples/non-java.xml
index 68f10a240701..f85db9495ac9 100644
--- a/modules/openapi-generator-maven-plugin/examples/non-java.xml
+++ b/modules/openapi-generator-maven-plugin/examples/non-java.xml
@@ -13,7 +13,7 @@
org.openapitoolsopenapi-generator-maven-plugin
- 7.16.0-SNAPSHOT
+ 7.18.0-SNAPSHOT
diff --git a/modules/openapi-generator-maven-plugin/examples/spring.xml b/modules/openapi-generator-maven-plugin/examples/spring.xml
index e22b7a57a620..659ebab23025 100644
--- a/modules/openapi-generator-maven-plugin/examples/spring.xml
+++ b/modules/openapi-generator-maven-plugin/examples/spring.xml
@@ -20,7 +20,7 @@
org.openapitoolsopenapi-generator-maven-plugin
- 7.16.0-SNAPSHOT
+ 7.18.0-SNAPSHOT
@@ -111,7 +111,7 @@
org.openapitoolsjackson-databind-nullable
- 0.2.6
+ 0.2.7
diff --git a/modules/openapi-generator-maven-plugin/pom.xml b/modules/openapi-generator-maven-plugin/pom.xml
index c7459d8e8f17..ca4978d60d9d 100644
--- a/modules/openapi-generator-maven-plugin/pom.xml
+++ b/modules/openapi-generator-maven-plugin/pom.xml
@@ -5,7 +5,7 @@
org.openapitoolsopenapi-generator-project
- 7.16.0-SNAPSHOT
+ 7.18.0-SNAPSHOT../../pom.xml
diff --git a/modules/openapi-generator-online/pom.xml b/modules/openapi-generator-online/pom.xml
index 8cce1a787a72..08b7d222b7a6 100644
--- a/modules/openapi-generator-online/pom.xml
+++ b/modules/openapi-generator-online/pom.xml
@@ -4,7 +4,7 @@
org.openapitoolsopenapi-generator-project
- 7.16.0-SNAPSHOT
+ 7.18.0-SNAPSHOT../../pom.xml
diff --git a/modules/openapi-generator/pom.xml b/modules/openapi-generator/pom.xml
index 884c6358af5b..80d88e8c7173 100644
--- a/modules/openapi-generator/pom.xml
+++ b/modules/openapi-generator/pom.xml
@@ -4,7 +4,7 @@
org.openapitoolsopenapi-generator-project
- 7.16.0-SNAPSHOT
+ 7.18.0-SNAPSHOT../../pom.xml
diff --git a/modules/openapi-generator/src/main/java/org/openapitools/codegen/CodegenConstants.java b/modules/openapi-generator/src/main/java/org/openapitools/codegen/CodegenConstants.java
index ae52412b7d2d..022089190ee4 100644
--- a/modules/openapi-generator/src/main/java/org/openapitools/codegen/CodegenConstants.java
+++ b/modules/openapi-generator/src/main/java/org/openapitools/codegen/CodegenConstants.java
@@ -454,4 +454,33 @@ public static enum ENUM_PROPERTY_NAMING_TYPE {camelCase, PascalCase, snake_case,
public static final String WAIT_TIME_OF_THREAD = "waitTimeMillis";
public static final String USE_DEFAULT_VALUES_FOR_REQUIRED_VARS = "useDefaultValuesForRequiredVars";
+
+ public static final String DEFAULT_TO_EMPTY_CONTAINER = "defaultToEmptyContainer";
+
+ // Vendor extensions
+ public static final String X_INTERNAL = "x-internal";
+ public static final String X_PARENT = "x-parent";
+ public static final String X_COMPOSED_DATA_TYPE = "x-composed-data-type";
+ public static final String X_BASE_NAME = "x-base-name";
+ public static final String X_IS_VALUE_TYPE = "x-is-value-type";
+ public static final String X_IS_REFERENCE_TYPE = "x-is-reference-type";
+ public static final String X_IS_NULLABLE_TYPE = "x-is-nullable-type";
+ public static final String X_IS_BASE_OR_NEW_DISCRIMINATOR = "x-is-base-or-new-discriminator";
+ public static final String X_ENUM_BYTE = "x-enum-byte";
+ public static final String X_HTTP_STATUS = "x-http-status";
+ public static final String X_HTTP_STATUSES_WITH_RETURN = "x-http-statuses-with-return";
+ public static final String X_SET_COOKIE = "x-set-cookie";
+ public static final String X_DUPLICATES = "x-duplicates";
+ public static final String X_HTTP_STATUS_IS_DEFAULT = "x-http-status-is-default";
+ public static final String X_ONLY_DEFAULT = "x-only-default";
+ public static final String X_HTTP_STATUS_RANGE = "x-http-status-range";
+ public static final String X_NOT_NULLABLE_REFERENCE_TYPES = "x-not-nullable-reference-types";
+ public static final String X_HAS_NOT_NULLABLE_REFERENCE_TYPES = "x-has-not-nullable-reference-types";
+ public static final String X_NULLABLE_VALUE_TYPE = "x-nullable-value-type";
+ public static final String X_NULLABLE_TYPE = "x-nullable-type";
+ public static final String X_CSHARP_VALUE_TYPE = "x-csharp-value-type";
+ public static final String X_REGEX = "x-regex";
+ public static final String X_MODIFIERS = "x-modifiers";
+ public static final String X_MODIFIER_PREFIX = "x-modifier-";
+ public static final String X_MODEL_IS_MUTABLE = "x-model-is-mutable";
}
diff --git a/modules/openapi-generator/src/main/java/org/openapitools/codegen/CodegenModel.java b/modules/openapi-generator/src/main/java/org/openapitools/codegen/CodegenModel.java
index 24fceaa88e30..f188b31ab8e4 100644
--- a/modules/openapi-generator/src/main/java/org/openapitools/codegen/CodegenModel.java
+++ b/modules/openapi-generator/src/main/java/org/openapitools/codegen/CodegenModel.java
@@ -265,6 +265,15 @@ public class CodegenModel implements IJsonSchemaValidationProperties {
private Map requiredVarsMap;
private String ref;
+ /**
+ * An alias for vendor extensions, e.g. one can use {{exts.x-something}} for cleaner template
+ *
+ * @return vendor extensions
+ */
+ public Map getExts() {
+ return vendorExtensions;
+ }
+
@Override
public CodegenProperty getContains() {
return contains;
@@ -365,7 +374,6 @@ public String getDiscriminatorName() {
return discriminator == null ? null : discriminator.getPropertyName();
}
-
@Override
public String getPattern() {
return pattern;
diff --git a/modules/openapi-generator/src/main/java/org/openapitools/codegen/CodegenOperation.java b/modules/openapi-generator/src/main/java/org/openapitools/codegen/CodegenOperation.java
index d204fe4246af..47e09ea292d4 100644
--- a/modules/openapi-generator/src/main/java/org/openapitools/codegen/CodegenOperation.java
+++ b/modules/openapi-generator/src/main/java/org/openapitools/codegen/CodegenOperation.java
@@ -79,6 +79,15 @@ private static boolean nonEmpty(Map params) {
return params != null && !params.isEmpty();
}
+ /**
+ * An alias for vendor extensions, e.g. one can use {{exts.x-something}} for cleaner template
+ *
+ * @return vendor extensions
+ */
+ public Map getExts() {
+ return vendorExtensions;
+ }
+
/**
* Check if there's at least one parameter
*
@@ -115,6 +124,15 @@ public boolean getHasBodyParam() {
return nonEmpty(bodyParams);
}
+ /**
+ * Check if there's at least one optional body parameter
+ *
+ * @return true if optional body parameter exists, false otherwise
+ */
+ public boolean getHasOptionalBodyParam() {
+ return nonEmpty(bodyParams) && nonEmpty(optionalParams) && bodyParams.stream().anyMatch(optionalParams::contains);
+ }
+
/**
* Check if there's at least one query parameter
*
diff --git a/modules/openapi-generator/src/main/java/org/openapitools/codegen/CodegenParameter.java b/modules/openapi-generator/src/main/java/org/openapitools/codegen/CodegenParameter.java
index 823dc0e9ffda..90c4c66558c0 100644
--- a/modules/openapi-generator/src/main/java/org/openapitools/codegen/CodegenParameter.java
+++ b/modules/openapi-generator/src/main/java/org/openapitools/codegen/CodegenParameter.java
@@ -534,6 +534,15 @@ public String toString() {
return sb.toString();
}
+ /**
+ * An alias for vendor extensions, e.g. one can use {{exts.x-something}} for cleaner template
+ *
+ * @return vendor extensions
+ */
+ public Map getExts() {
+ return vendorExtensions;
+ }
+
// use schema.getContains or content.mediaType.schema.getContains instead of this
@Override
public CodegenProperty getContains() {
diff --git a/modules/openapi-generator/src/main/java/org/openapitools/codegen/CodegenProperty.java b/modules/openapi-generator/src/main/java/org/openapitools/codegen/CodegenProperty.java
index c374b0204c1c..c854389be7b2 100644
--- a/modules/openapi-generator/src/main/java/org/openapitools/codegen/CodegenProperty.java
+++ b/modules/openapi-generator/src/main/java/org/openapitools/codegen/CodegenProperty.java
@@ -436,6 +436,15 @@ public boolean notRequiredOrIsNullable() {
return !getRequired() || isNullable;
}
+ /**
+ * An alias for vendor extensions, e.g. one can use {{exts.x-something}} for cleaner template
+ *
+ * @return vendor extensions
+ */
+ public Map getExts() {
+ return vendorExtensions;
+ }
+
@Override
public CodegenProperty getItems() {
return items;
diff --git a/modules/openapi-generator/src/main/java/org/openapitools/codegen/CodegenResponse.java b/modules/openapi-generator/src/main/java/org/openapitools/codegen/CodegenResponse.java
index aa06a9de135a..3298d80868f2 100644
--- a/modules/openapi-generator/src/main/java/org/openapitools/codegen/CodegenResponse.java
+++ b/modules/openapi-generator/src/main/java/org/openapitools/codegen/CodegenResponse.java
@@ -206,6 +206,15 @@ public boolean equals(Object o) {
}
+ /**
+ * An alias for vendor extensions, e.g. one can use {{exts.x-something}} for cleaner template
+ *
+ * @return vendor extensions
+ */
+ public Map getExts() {
+ return vendorExtensions;
+ }
+
// use content.mediaType.schema.getContains instead of this
@Override
public CodegenProperty getContains() {
diff --git a/modules/openapi-generator/src/main/java/org/openapitools/codegen/CodegenServer.java b/modules/openapi-generator/src/main/java/org/openapitools/codegen/CodegenServer.java
index 0a7c2455e0c7..04b64c41ce41 100644
--- a/modules/openapi-generator/src/main/java/org/openapitools/codegen/CodegenServer.java
+++ b/modules/openapi-generator/src/main/java/org/openapitools/codegen/CodegenServer.java
@@ -38,4 +38,13 @@ public String toString() {
sb.append('}');
return sb.toString();
}
+
+ /**
+ * An alias for vendor extensions, e.g. one can use {{exts.x-something}} for cleaner template
+ *
+ * @return vendor extensions
+ */
+ public Map getExts() {
+ return vendorExtensions;
+ }
}
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 db2f6a563e91..94eb3273c049 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
@@ -88,7 +88,7 @@
import java.util.stream.Collectors;
import java.util.stream.Stream;
-import static org.openapitools.codegen.CodegenConstants.UNSUPPORTED_V310_SPEC_MSG;
+import static org.openapitools.codegen.CodegenConstants.*;
import static org.openapitools.codegen.utils.CamelizeOption.LOWERCASE_FIRST_LETTER;
import static org.openapitools.codegen.utils.OnceLogger.once;
import static org.openapitools.codegen.utils.StringUtils.*;
@@ -338,7 +338,7 @@ apiTemplateFiles are for API outputs only (controllers/handlers).
@Setter @Getter boolean arrayDefaultToEmpty, arrayNullableDefaultToEmpty, arrayOptionalNullableDefaultToEmpty, arrayOptionalDefaultToEmpty;
@Setter @Getter boolean mapDefaultToEmpty, mapNullableDefaultToEmpty, mapOptionalNullableDefaultToEmpty, mapOptionalDefaultToEmpty;
@Setter @Getter protected boolean defaultToEmptyContainer;
- final String DEFAULT_TO_EMPTY_CONTAINER = "defaultToEmptyContainer";
+
final List EMPTY_LIST = new ArrayList();
@Override
@@ -4289,7 +4289,7 @@ void updateDefaultToEmptyContainer(CodegenProperty cp, Schema p) {
} else { // required
if (cp.isNullable && mapNullableDefaultToEmpty) { // nullable
p.setDefault(EMPTY_LIST);
- } else if (!cp.isNullable && mapOptionalDefaultToEmpty) { // non-nullable
+ } else if (!cp.isNullable && mapDefaultToEmpty) { // non-nullable
p.setDefault(EMPTY_LIST);
}
}
@@ -5196,7 +5196,7 @@ public CodegenCallback fromCallback(String name, Callback callback, List
String method = p.getKey();
Operation op = p.getValue();
- if (op.getExtensions() != null && Boolean.TRUE.equals(op.getExtensions().get("x-internal"))) {
+ if (op.getExtensions() != null && Boolean.TRUE.equals(op.getExtensions().get(X_INTERNAL))) {
// skip operation if x-internal sets to true
LOGGER.info("Operation ({} {} - {}) not generated since x-internal is set to true",
method, expression, op.getOperationId());
@@ -5734,7 +5734,7 @@ private CodegenSecurity defaultCodegenSecurity(String key, SecurityScheme securi
cs.name = key;
cs.description = securityScheme.getDescription();
cs.type = securityScheme.getType().toString();
- cs.isCode = cs.isPassword = cs.isApplication = cs.isImplicit = cs.isOpenId = false;
+ cs.isCode = cs.isPassword = cs.isApplication = cs.isImplicit = cs.isOpenId = cs.isOAuth = false;
cs.isHttpSignature = false;
cs.isBasicBasic = cs.isBasicBearer = false;
cs.scheme = securityScheme.getScheme();
diff --git a/modules/openapi-generator/src/main/java/org/openapitools/codegen/DefaultGenerator.java b/modules/openapi-generator/src/main/java/org/openapitools/codegen/DefaultGenerator.java
index 8750031094c9..999beb6ad3ce 100644
--- a/modules/openapi-generator/src/main/java/org/openapitools/codegen/DefaultGenerator.java
+++ b/modules/openapi-generator/src/main/java/org/openapitools/codegen/DefaultGenerator.java
@@ -61,6 +61,7 @@
import java.util.stream.Collectors;
import static org.apache.commons.lang3.StringUtils.removeStart;
+import static org.openapitools.codegen.CodegenConstants.X_INTERNAL;
import static org.openapitools.codegen.utils.OnceLogger.once;
@SuppressWarnings("rawtypes")
@@ -486,7 +487,7 @@ void generateModels(List files, List allModels, List unu
Schema schema = ModelUtils.getSchemas(this.openAPI).get(name);
- if (schema.getExtensions() != null && Boolean.TRUE.equals(schema.getExtensions().get("x-internal"))) {
+ if (schema.getExtensions() != null && Boolean.TRUE.equals(schema.getExtensions().get(X_INTERNAL))) {
LOGGER.info("Model {} not generated since x-internal is set to true", name);
continue;
} else if (ModelUtils.isFreeFormObject(schema, openAPI)) { // check to see if it's a free-form object
@@ -1564,7 +1565,7 @@ private void processOperation(String resourcePath, String httpMethod, Operation
final List globalSecurities = openAPI.getSecurity();
for (Tag tag : tags) {
try {
- if (operation.getExtensions() != null && Boolean.TRUE.equals(operation.getExtensions().get("x-internal"))) {
+ if (operation.getExtensions() != null && Boolean.TRUE.equals(operation.getExtensions().get(X_INTERNAL))) {
// skip operation if x-internal sets to true
LOGGER.info("Operation ({} {} - {}) not generated since x-internal is set to true",
httpMethod, resourcePath, operation.getOperationId());
diff --git a/modules/openapi-generator/src/main/java/org/openapitools/codegen/InlineModelResolver.java b/modules/openapi-generator/src/main/java/org/openapitools/codegen/InlineModelResolver.java
index aa32789d1b25..777fed9b2cb4 100644
--- a/modules/openapi-generator/src/main/java/org/openapitools/codegen/InlineModelResolver.java
+++ b/modules/openapi-generator/src/main/java/org/openapitools/codegen/InlineModelResolver.java
@@ -356,7 +356,9 @@ private void gatherInlineModels(Schema schema, String modelPrefix) {
} else if (schema.getProperties() != null) {
// If non-object type is specified but also properties
LOGGER.error("Illegal schema found with non-object type combined with properties," +
- " no properties should be defined:\n " + schema.toString());
+ " no properties should be defined:" +
+ " consider using --openapi-normalizer REMOVE_PROPERTIES_FROM_TYPE_OTHER_THAN_OBJECT=true\n " +
+ schema.toString());
return;
} else if (schema.getAdditionalProperties() != null) {
// If non-object type is specified but also additionalProperties
diff --git a/modules/openapi-generator/src/main/java/org/openapitools/codegen/OpenAPINormalizer.java b/modules/openapi-generator/src/main/java/org/openapitools/codegen/OpenAPINormalizer.java
index 01ee01b83594..64ed0b624d11 100644
--- a/modules/openapi-generator/src/main/java/org/openapitools/codegen/OpenAPINormalizer.java
+++ b/modules/openapi-generator/src/main/java/org/openapitools/codegen/OpenAPINormalizer.java
@@ -37,6 +37,8 @@
import java.util.function.Function;
import java.util.stream.Collectors;
+import static org.openapitools.codegen.CodegenConstants.X_INTERNAL;
+import static org.openapitools.codegen.CodegenConstants.X_PARENT;
import static org.openapitools.codegen.utils.ModelUtils.simplifyOneOfAnyOfWithOnlyOneNonNullSubSchema;
import static org.openapitools.codegen.utils.StringUtils.getUniqueString;
@@ -47,7 +49,7 @@ public class OpenAPINormalizer {
private TreeSet anyTypeTreeSet = new TreeSet<>();
- protected final Logger LOGGER = LoggerFactory.getLogger(OpenAPINormalizer.class);
+ protected static final Logger LOGGER = LoggerFactory.getLogger(OpenAPINormalizer.class);
Set ruleNames = new TreeSet<>();
Set rulesDefaultToTrue = new TreeSet<>();
@@ -122,20 +124,18 @@ public class OpenAPINormalizer {
// the allOf contains a new schema containing the properties in the top level
final String REFACTOR_ALLOF_WITH_PROPERTIES_ONLY = "REFACTOR_ALLOF_WITH_PROPERTIES_ONLY";
+ // when set to true, remove the "properties" of a schema with type other than "object"
+ final String REMOVE_PROPERTIES_FROM_TYPE_OTHER_THAN_OBJECT = "REMOVE_PROPERTIES_FROM_TYPE_OTHER_THAN_OBJECT";
+
// when set to true, normalize OpenAPI 3.1 spec to make it work with the generator
final String NORMALIZE_31SPEC = "NORMALIZE_31SPEC";
// when set to true, remove x-internal: true from models, operations
final String REMOVE_X_INTERNAL = "REMOVE_X_INTERNAL";
- final String X_INTERNAL = "x-internal";
boolean removeXInternal;
// when set (e.g. operationId:getPetById|addPet), filter out (or remove) everything else
final String FILTER = "FILTER";
- HashSet operationIdFilters = new HashSet<>();
- HashSet methodFilters = new HashSet<>();
-
- HashSet tagFilters = new HashSet<>();
// when set (e.g. operationId:getPetById|addPet), filter out (or remove) everything else
final String SET_CONTAINER_TO_NULLABLE = "SET_CONTAINER_TO_NULLABLE";
@@ -209,11 +209,13 @@ public OpenAPINormalizer(OpenAPI openAPI, Map inputRules) {
ruleNames.add(SET_CONTAINER_TO_NULLABLE);
ruleNames.add(SET_PRIMITIVE_TYPES_TO_NULLABLE);
ruleNames.add(SIMPLIFY_ONEOF_ANYOF_ENUM);
+ ruleNames.add(REMOVE_PROPERTIES_FROM_TYPE_OTHER_THAN_OBJECT);
// rules that are default to true
rules.put(SIMPLIFY_ONEOF_ANYOF, true);
rules.put(SIMPLIFY_BOOLEAN_ENUM, true);
rules.put(SIMPLIFY_ONEOF_ANYOF_ENUM, true);
+ rules.put(REFACTOR_ALLOF_WITH_PROPERTIES_ONLY, true);
processRules(inputRules);
@@ -274,30 +276,7 @@ public void processRules(Map inputRules) {
if (inputRules.get(FILTER) != null) {
rules.put(FILTER, true);
-
- String[] filterStrs = inputRules.get(FILTER).split(":");
- if (filterStrs.length != 2) { // only support operationId with : at the moment
- LOGGER.error("FILTER rule must be in the form of `operationId:name1|name2|name3` or `method:get|post|put` or `tag:tag1|tag2|tag3`: {}", inputRules.get(FILTER));
- } else {
- if ("operationId".equals(filterStrs[0])) {
- operationIdFilters = Arrays.stream(filterStrs[1].split("[|]"))
- .filter(Objects::nonNull)
- .map(String::trim)
- .collect(Collectors.toCollection(HashSet::new));
- } else if ("method".equals(filterStrs[0])) {
- methodFilters = Arrays.stream(filterStrs[1].split("[|]"))
- .filter(Objects::nonNull)
- .map(String::trim)
- .collect(Collectors.toCollection(HashSet::new));
- } else if ("tag".equals(filterStrs[0])) {
- tagFilters = Arrays.stream(filterStrs[1].split("[|]"))
- .filter(Objects::nonNull)
- .map(String::trim)
- .collect(Collectors.toCollection(HashSet::new));
- } else {
- LOGGER.error("FILTER rule must be in the form of `operationId:name1|name2|name3` or `method:get|post|put` or `tag:tag1|tag2|tag3`: {}", inputRules.get(FILTER));
- }
- }
+ // actual parsing is delayed to allow customization of the Filter processing
}
if (inputRules.get(SET_CONTAINER_TO_NULLABLE) != null) {
@@ -343,6 +322,19 @@ public void processRules(Map inputRules) {
}
}
+ /**
+ * Create the filter to process the FILTER normalizer.
+ * Override this to create a custom filter normalizer.
+ *
+ * @param openApi Contract used in the filtering (could be used for customization).
+ * @param filters full FILTER value
+ *
+ * @return a Filter containing the parsed filters.
+ */
+ protected Filter createFilter(OpenAPI openApi, String filters) {
+ return new Filter(filters);
+ }
+
/**
* Normalizes the OpenAPI input, which may not perfectly conform to
* the specification.
@@ -404,15 +396,15 @@ protected void normalizePaths() {
"trace", PathItem::getTrace
);
- // Iterates over each HTTP method in methodMap, retrieves the corresponding Operation from the PathItem,
- // and marks it as internal (`x-internal`) if the method is not in methodFilters.
- methodMap.forEach((method, getter) -> {
- Operation operation = getter.apply(path);
- if (operation != null && !methodFilters.isEmpty()) {
- LOGGER.info("operation `{}` marked internal only (x-internal: `{}`) by the method FILTER", operation.getOperationId(), !methodFilters.contains(method));
- operation.addExtension("x-internal", !methodFilters.contains(method));
+ if (Boolean.TRUE.equals(getRule(FILTER))) {
+ String filters = inputRules.get(FILTER);
+ Filter filter = createFilter(this.openAPI, filters);
+ if (filter.parse()) {
+ // Iterates over each HTTP method in methodMap, retrieves the corresponding Operations from the PathItem,
+ // and marks it as internal (`x-internal=true`) if the method/operationId/tag/path is not in the filters.
+ filter.apply(pathsEntry.getKey(), path, methodMap);
}
- });
+ }
// Include callback operation as well
for (Operation operation : path.readOperations()) {
@@ -429,22 +421,6 @@ protected void normalizePaths() {
normalizeParameters(path.getParameters());
for (Operation operation : operations) {
- if (operationIdFilters.size() > 0) {
- if (operationIdFilters.contains(operation.getOperationId())) {
- operation.addExtension("x-internal", false);
- } else {
- LOGGER.info("operation `{}` marked as internal only (x-internal: true) by the operationId FILTER", operation.getOperationId());
- operation.addExtension("x-internal", true);
- }
- } else if (!tagFilters.isEmpty()) {
- if (operation.getTags().stream().anyMatch(tagFilters::contains)) {
- operation.addExtension("x-internal", false);
- } else {
- LOGGER.info("operation `{}` marked as internal only (x-internal: true) by the tag FILTER", operation.getOperationId());
- operation.addExtension("x-internal", true);
- }
- }
-
normalizeOperation(operation);
normalizeRequestBody(operation);
normalizeParameters(operation.getParameters());
@@ -723,15 +699,19 @@ public Schema normalizeSchema(Schema schema, Set visitedSchemas) {
if (skipNormalization(schema, visitedSchemas)) {
return schema;
}
+
+ if (ModelUtils.isNullTypeSchema(openAPI, schema)) {
+ return schema;
+ }
+
markSchemaAsVisited(schema, visitedSchemas);
+ processNormalizeOtherThanObjectWithProperties(schema);
+
if (ModelUtils.isArraySchema(schema)) { // array
Schema result = normalizeArraySchema(schema);
normalizeSchema(result.getItems(), visitedSchemas);
return result;
- } else if (schema.getAdditionalProperties() instanceof Schema) { // map
- normalizeMapSchema(schema);
- normalizeSchema((Schema) schema.getAdditionalProperties(), visitedSchemas);
} else if (ModelUtils.isOneOf(schema)) { // oneOf
return normalizeOneOf(schema, visitedSchemas);
} else if (ModelUtils.isAnyOf(schema)) { // anyOf
@@ -768,6 +748,9 @@ public Schema normalizeSchema(Schema schema, Set visitedSchemas) {
return schema;
} else if (schema.getProperties() != null && !schema.getProperties().isEmpty()) {
normalizeProperties(schema.getProperties(), visitedSchemas);
+ } else if (schema.getAdditionalProperties() instanceof Schema) { // map
+ normalizeMapSchema(schema);
+ normalizeSchema((Schema) schema.getAdditionalProperties(), visitedSchemas);
} else if (schema instanceof BooleanSchema) {
normalizeBooleanSchema(schema, visitedSchemas);
} else if (schema instanceof IntegerSchema) {
@@ -849,6 +832,20 @@ protected void normalizeProperties(Map properties, Set v
}
for (Map.Entry propertiesEntry : properties.entrySet()) {
Schema property = propertiesEntry.getValue();
+
+ // remove x-internal if needed (same logic as normalizeComponentsSchemas)
+ if (property.getExtensions() != null && getRule(REMOVE_X_INTERNAL)) {
+ Object xInternalValue = property.getExtensions().get(X_INTERNAL);
+ boolean isInternal = false;
+ if (xInternalValue instanceof Boolean) {
+ isInternal = (Boolean) xInternalValue;
+ } else if (xInternalValue instanceof String) {
+ isInternal = Boolean.parseBoolean((String) xInternalValue);
+ }
+ if (isInternal) {
+ property.getExtensions().remove(X_INTERNAL);
+ }
+ }
Schema newProperty = normalizeSchema(property, new HashSet<>());
propertiesEntry.setValue(newProperty);
}
@@ -1011,6 +1008,7 @@ protected Schema normalizeAnyOf(Schema schema, Set visitedSchemas) {
if (schema.getAnyOf() == null) {
return schema;
}
+
for (int i = 0; i < schema.getAnyOf().size(); i++) {
// normalize anyOf sub schemas one by one
Object item = schema.getAnyOf().get(i);
@@ -1083,10 +1081,10 @@ protected void processUseAllOfRefAsParent(Schema schema) {
refSchema.setExtensions(new HashMap<>());
}
- if (refSchema.getExtensions().containsKey("x-parent")) {
+ if (refSchema.getExtensions().containsKey(X_PARENT)) {
// doing nothing as x-parent already exists
} else {
- refSchema.getExtensions().put("x-parent", true);
+ refSchema.getExtensions().put(X_PARENT, true);
}
LOGGER.debug("processUseAllOfRefAsParent added `x-parent: true` to {}", refSchema);
@@ -1108,7 +1106,7 @@ protected void processRemoveXInternalFromOperation(Operation operation) {
return;
}
- if (Boolean.parseBoolean(String.valueOf(operation.getExtensions().get("x-internal")))) {
+ if (Boolean.parseBoolean(String.valueOf(operation.getExtensions().get(X_INTERNAL)))) {
operation.getExtensions().remove(X_INTERNAL);
}
}
@@ -1342,7 +1340,7 @@ protected Schema processSimplifyOneOfEnum(Schema schema) {
*
* @param schema Schema to modify
* @param subSchemas List of sub-schemas to check
- * @param schemaType Type of composed schema ("oneOf" or "anyOf")
+ * @param composedType Type of composed schema ("oneOf" or "anyOf")
* @return Simplified schema
*/
protected Schema simplifyComposedSchemaWithEnums(Schema schema, List