[BUG] Gradle Plugin - configOptions unclear / inconsistent

Bug Report Checklist

x

Couldn’t find a repo for the gradle plugin so I’m posting this here.

Description

The gradle plugin offers some configuration option. But it’s not clear what has to go where. The docs have an example:

openApiGenerate {
    generatorName = "kotlin"
    inputSpec = "$rootDir/specs/petstore-v3.0.yaml".toString()
    outputDir = "$buildDir/generated".toString()
    apiPackage = "org.openapi.example.api"
    invokerPackage = "org.openapi.example.invoker"
    modelPackage = "org.openapi.example.model"
    modelFilesConstrainedTo = [
            "Error"
    ]
    configOptions = [
        dateLibrary: "java8"
    ]
}

Why is dateLibrary nested inside configOptions or regardingly, why isn’t e.g. invokerPackage within configOptions, too? Both are listed in the same table [1] [2] captioned “config options”. So I’d expect all those settings to live within configOptions or none.

openapi-generator version

4.x & 5.0.0-beta2

Suggest a fix

I didn’t take a look at the other generators. Maybe I’m just blind and it’s stated somewhere.

My first shot to fix this would be to unnest configOptions so that above example becomes:

openApiGenerate {
    generatorName = "kotlin"
    inputSpec = "$rootDir/specs/petstore-v3.0.yaml".toString()
    outputDir = "$buildDir/generated".toString()
    apiPackage = "org.openapi.example.api"
    invokerPackage = "org.openapi.example.invoker"
    modelPackage = "org.openapi.example.model"
    modelFilesConstrainedTo = [
            "Error"
    ]
    dateLibrary = "java8"
}

[black-snow]

I’m not doing anything with kotlin, it’s 100% java. All I did was picking the example from the docs.

My config looks like

openApiGenerate {
	generatorName = "java"
	library = "webclient"
	verbose = true
	validateSpec = true
	skipValidateSpec = false
	inputSpec = "$rootDir/src/main/resources/schema_oas3.yaml"
	outputDir = "$rootDir/../api"
	configOptions = [
		dateLibrary: "java8",
		openApiNullable: "true"
	]
	apiPackage = 'a.b.xyz.openapi'
	modelPackage = 'a.b.xyz.openapi.model'
	invokerPackage = 'a.b.xyz.openapi.client'
	groupId = 'a.b'
	id = 'xyz'
	version = '0.1'
}

My point was that it’s not clear to me what goes inside configOptions and what not, because openApiNullable is listed at the same level as e.g. apiPackage and not nested inside some configOptions.

[black-snow]

Awesome. Thanks for your efforts. I’ll close this specific issue then.