Skip to content

Commit 7b04732

Browse files
wing328jimschubert
authored andcommitted
better explain usage (#794)
1 parent b64864f commit 7b04732

1 file changed

Lines changed: 3 additions & 1 deletion

File tree

  • modules/openapi-generator-maven-plugin

modules/openapi-generator-maven-plugin/README.md

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -37,6 +37,8 @@ mvn clean compile
3737

3838
### General Configuration parameters
3939

40+
:bulb: These **general** configurations should be in the same level
41+
4042
- `inputSpec` - OpenAPI Spec file path
4143
- `validateSpec` - Whether or not to validate the input spec prior to generation. Invalid specifications will result in an error.
4244
- `language` - target generation language (deprecated, replaced by `generatorName` as values here don't represent only 'language' any longer)
@@ -49,7 +51,7 @@ mvn clean compile
4951
- `invokerPackage` - the package to use for the generated invoker objects
5052
- `modelNamePrefix` and `modelNameSuffix` - Sets the pre- or suffix for model classes and enums
5153
- `withXml` - enable XML annotations inside the generated models and API (only works with Java `language` and libraries that provide support for JSON and XML)
52-
- `configOptions` - a map of language-specific parameters (see below)
54+
- `configOptions` - a map of language-specific parameters. To show a full list of generator-specified parameters (options), please use `configHelp` (explained below)
5355
- `configHelp` - dumps the configuration help for the specified library (generates no sources)
5456
- `ignoreFileOverride` - specifies the full path to a `.openapi-generator-ignore` used for pattern based overrides of generated outputs
5557
- `generateApis` - generate the apis (`true` by default)

0 commit comments

Comments
 (0)