From b1dc2eeaacfb33f491683fab94e4d5247f8daeb4 Mon Sep 17 00:00:00 2001 From: Vincent Devos <46601673+karismann@users.noreply.github.com> Date: Tue, 12 Mar 2019 03:15:52 +0100 Subject: [PATCH] [Maven doc] fix/add General Configuration parameters (#2359) --- modules/openapi-generator-maven-plugin/README.md | 5 +++-- 1 file changed, 3 insertions(+), 2 deletions(-) diff --git a/modules/openapi-generator-maven-plugin/README.md b/modules/openapi-generator-maven-plugin/README.md index ce752714ee1..18f5668bf98 100644 --- a/modules/openapi-generator-maven-plugin/README.md +++ b/modules/openapi-generator-maven-plugin/README.md @@ -43,7 +43,7 @@ mvn clean compile - `validateSpec` - Whether or not to validate the input spec prior to generation. Invalid specifications will result in an error. - `language` - target generation language (deprecated, replaced by `generatorName` as values here don't represent only 'language' any longer) - `generatorName` - target generator name -- `output` - target output path (default is `${project.build.directory}/generated-sources/swagger`. Can also be set globally through the `openapi.generator.maven.plugin.output` property) +- `output` - target output path (default is `${project.build.directory}/generated-sources/openapi`. Can also be set globally through the `openapi.generator.maven.plugin.output` property) - `templateDirectory` - directory with mustache templates - `addCompileSourceRoot` - add the output directory to the project as a source root (`true` by default) - `modelPackage` - the package to use for generated model objects/classes @@ -70,7 +70,8 @@ mvn clean compile - `supportingFilesToGenerate` - A comma separated list of supporting files to generate. All files is the default. - `skip` - skip code generation (`false` by default. Can also be set globally through the `codegen.skip` property) - `verbose` - verbose mode (`false` by default) -- `gitUserId` and `gitRepoId` - git infos of the project +- `groupId`, `artifactId` and `artifactVersion` - sets project information in generated pom.xml/build.gradle or other build script. Language-specific conversions occur in non-jvm generators +- `gitUserId` and `gitRepoId` - sets git information of the project - `auth` - adds authorization headers when fetching the OpenAPI definitions remotely. Pass in a URL-encoded string of `name:header` with a comma separating multiple values - `configurationFile` - Path to separate json configuration file. 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 - `skipOverwrite` - Specifies if the existing files should be overwritten during the generation. (`false` by default)