loafle/openapi-generator
3
0
Fork 0
forked from loafle/openapi-generator-original
Code Pull Requests Activity

[Doc] Better highlight of generators docs page with generators specific parameters (#2592)

Browse Source 
* [Doc] Better highlight of generators docs page with generators specific parameters

* [Doc] Better highlight of generators docs page with generators specific parameters
This commit is contained in:
Vincent Devos 2019-04-05 00:38:33 +02:00 committed by William Cheng
parent 158ac6d178
commit 117efe83c0
3 changed files with 4 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
docs/usage.md
View File

@ -426,6 +426,8 @@ To pass more than one generator property, these can be combined via comma:
--additional-properties=key1=value1,key2=value2 --additional-properties=key1=value1,key2=value2
``` ```
For the full list of generator-specified parameters, refer to [generators docs]((./generators.md))
#### Type Mappings and Import Mappings #### Type Mappings and Import Mappings
Most generators allow for types bound to the OpenAPI Specification's types to be remapped to a user's desired types. Not _all_ type mappings can be reassigned, as some generators define mappings which are tightly coupled to the built-in templates. Most generators allow for types bound to the OpenAPI Specification's types to be remapped to a user's desired types. Not _all_ type mappings can be reassigned, as some generators define mappings which are tightly coupled to the built-in templates.

2
modules/openapi-generator-gradle-plugin/README.adoc
View File

@ -266,7 +266,7 @@ The gradle plugin is not currently published to https://plugins.gradle.org/m2/.
|configOptions |configOptions
|Map(String,String) |Map(String,String)
|None |None
|A map of options specific to a generator. |A map of options specific to a generator. To see the full list of generator-specified parameters, please refer to [generators docs](https://github.com/OpenAPITools/openapi-generator/blob/master/docs/generators.md)
|logToStderr |logToStderr
|Boolean |Boolean

2
modules/openapi-generator-maven-plugin/README.md
View File

@ -51,7 +51,7 @@ mvn clean compile
- `invokerPackage` - the package to use for the generated invoker objects - `invokerPackage` - the package to use for the generated invoker objects
- `modelNamePrefix` and `modelNameSuffix` - Sets the pre- or suffix for model classes and enums - `modelNamePrefix` and `modelNameSuffix` - Sets the pre- or suffix for model classes and enums
- `withXml` - enable XML annotations inside the generated models and API (only works with Java `language` and libraries that provide support for JSON and XML) - `withXml` - enable XML annotations inside the generated models and API (only works with Java `language` and libraries that provide support for JSON and XML)
- `configOptions` - a map of language-specific parameters. To show a full list of generator-specified parameters (options), please use `configHelp` (explained below) - `configOptions` - a map of language-specific parameters. To show a full list of generator-specified parameters (options), please use `configHelp` (explained below) or refer to [generators docs](../../docs/generators.md)
- `configHelp` - dumps the configuration help for the specified library (generates no sources) - `configHelp` - dumps the configuration help for the specified library (generates no sources)
- `ignoreFileOverride` - specifies the full path to a `.openapi-generator-ignore` used for pattern based overrides of generated outputs - `ignoreFileOverride` - specifies the full path to a `.openapi-generator-ignore` used for pattern based overrides of generated outputs
- `removeOperationIdPrefix` - remove operationId prefix (e.g. user_getName => getName) - `removeOperationIdPrefix` - remove operationId prefix (e.g. user_getName => getName)