diff --git a/docs/configuration.md b/docs/configuration.md new file mode 100644 index 0000000000000000000000000000000000000000..1fa33922ce8dc77afe5d1768990463f5c1474fba --- /dev/null +++ b/docs/configuration.md @@ -0,0 +1,118 @@ +--- +id: configuration +title: Configuration Options +--- + +Our tooling supports the following types of configuration: + +* [global properties](./global-properties.md) + - properties with cross-cutting concerns which control generation, but _don't_ belong to individual generators + - Example: `debugSupportingFiles` prints the contents of template data bound to supporting files +* config options + - configuration specific to each individual [generator](./generators/README.md) + - these options are susceptible to validation within the defining generator; a config option of the same name across multiple generators may be validated differently in each + - NOTE: The CLI accepts config options as "additional properties" +* additional properties + - these are the properties which will be passed to templates + - generally used to pass user-defined properties to custom templates + - many config options may also be passed as additional properties, however generators will read/modify/rewrite config options + - users may pass custom additional properties and use these within templates (e.g. a custom `generatedBy` key with a value of `Jim Schubert` for inclusion in a custom CVS-like header) +* top-level properties specific to individual tools/plugins used to bootstrap our tooling + +## Tool-specific Declarations + +The READMEs for the [CLI](https://openapi-generator.tech/docs/usage#generate), [Gradle Plugin](https://github.com/OpenAPITools/openapi-generator/tree/master/modules/openapi-generator-maven-plugin), [Maven Plugin](https://github.com/OpenAPITools/openapi-generator/tree/master/modules/openapi-generator-maven-plugin), and [SBT Plugin](https://github.com/OpenAPITools/sbt-openapi-generator/blob/master/README.md) may have top-level or tooling specific options which appear to duplicate 'config options' or 'global properties'. Each may also expose user-facing properties slightly differently from the other tools. This may occur due to: + +* Conventions used by the underlying tooling +* Limitations in underlying frameworks which define how properties must be declared +* Continuation of support for "legacy" invocation patterns +* Mistakes in documentation and/or contributions (please do [file a bug](https://github.com/OpenAPITools/openapi-generator/issues/new?assignees=&labels=Issue%3A+Bug&template=bug_report.md&title=%5BBUG%5D+Issue+with+options)) + +Take, for example, the CLI option of `--skip-validate-spec`. This flag sets the value to true with no option to set it to false (the default internally). The maven and gradle plugins allow for the top-level option `skipValidateSpec` to have a value of true or false. The SBT plugin, on the other hand, follows community convention and this property is `openApiSkipValidateSpec`. + +_How_ you provide values to options also depends on the tool. OpenAPI Generator supports global properties for [selective generation](https://openapi-generator.tech/docs/customization/#selective-generation) -- such as `apis` -- to have either a blank value or a comma-separated list of selected values. We would define this in CLI as `--global-property apis` or `--global-property apis=Equipment`. In the Gradle Plugin, these properties are set directly as strings: + +``` +openApiGenerate { + globalProperties = [ + apis: "", + models: "User,Pet" + ] +} +``` + +In the Maven plugin, we're limited by XML syntax where `<apis/>` and `<apis></apis>` are treated the same as if the `apis` node was undefined; there's no way to provide an empty string as a default. Instead, we have to extract the global property into its own properties which maintain the two states supported elsewhere (i.e. "all apis" or "select apis"). We have `generateApis` which accepts a boolean and `apisToGenerate` which accepts a comma-separated selection list. + +## Discovering Options + +Refer to [global properties](./global-properties.md) for a list of available global properties and their usage. + +Top-level tooling options are defined in [CLI usage](https://openapi-generator.tech/docs/usage/#generate). Many of these options directly map to camel case options in other tools, but do refer to [plugin documentation](https://openapi-generator.tech/docs/plugins) for full details or plugin-specific differences. + +Config options for generators are available in [documentation online](https://openapi-generator.tech/docs/generators). You may also use the CLI to query config options for a target generator using `openapi-generator config-help -g <generator-name>`. For example: + +``` +$ openapi-generator config-help -g mysql-schema + +CONFIG OPTIONS + + defaultDatabaseName + Default database name for all MySQL queries (Default: ) + + identifierNamingConvention + Naming convention of MySQL identifiers(table names and column names). This is not related to database name which is defined by defaultDatabaseName option (Default: original) + original - Do not transform original names + snake_case - Use snake_case names + + jsonDataTypeEnabled + Use special JSON MySQL data type for complex model properties. Requires MySQL version 5.7.8. Generates TEXT data type when disabled (Default: true) + + namedParametersEnabled + Generates model prepared SQLs with named parameters, eg. :petName. Question mark placeholder used when option disabled. (Default: false) +``` + +This output provides the name of the configuration option. A set of acceptable values for any constrained values will print as an indented list (e.g. `identifierNamingConvention` above). + +Suppose you want to apply snake case naming to mysql schema outputs. Your configuration might resemble the following examples. + +**CLI** + +``` +openapi-generator -g mysql-schema -o out -i spec.yaml --additional-properties=identifierNamingConvention=snake_case +``` + +It may seem like a typo but there are two `=` signs in the above example. + +**Maven Plugin** + +``` +<execution> + <id>mysql-schema</id> + <phase>generate-sources</phase> + <goals> + <goal>generate</goal> + </goals> + <configuration> + <inputSpec>spec.yaml</inputSpec> + <generatorName>mysql-schema</generatorName> + <configOptions> + <identifierNamingConvention>snake_case</identifierNamingConvention> + </configOptions> + <output>${project.build.directory}/generated-sources/mysql</output> + </configuration> +</execution> +``` + +**Gradle Plugin** + +``` +openApiGenerate { + generatorName = "mysql-schema" + inputSpec = "$rootDir/spec.yaml".toString() + outputDir = "$buildDir/mysql".toString() + configOptions = [ + identifierNamingConvention: "snake_case" + ] +} +``` + diff --git a/docs/generators/ada-server.md b/docs/generators/ada-server.md index 9806f13d3784c787cec23a3515bc88023053bfde..731aefee3588061e7593316ab8fe6ad15975681c 100644 --- a/docs/generators/ada-server.md +++ b/docs/generators/ada-server.md @@ -3,6 +3,8 @@ title: Config Options for ada-server sidebar_label: ada-server --- +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| diff --git a/docs/generators/ada.md b/docs/generators/ada.md index 7a58eb1232db64a0a0a28a75366d7af5cec7e895..7fe92e9ee48c457c37511f538f8902ee100508c5 100644 --- a/docs/generators/ada.md +++ b/docs/generators/ada.md @@ -3,6 +3,8 @@ title: Config Options for ada sidebar_label: ada --- +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| diff --git a/docs/generators/android.md b/docs/generators/android.md index 900c6e1c4b34fbf69dd722ce6d5fd4433c449500..6173d90e89d148b08008444ca4b7c1fbe499c921 100644 --- a/docs/generators/android.md +++ b/docs/generators/android.md @@ -3,6 +3,8 @@ title: Config Options for android sidebar_label: android --- +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| diff --git a/docs/generators/apache2.md b/docs/generators/apache2.md index 984a942c6ce0b2bd3f21bd65df08cbfe631ff3cd..0c33f09143ef88528a05d1d22900fc61f0191420 100644 --- a/docs/generators/apache2.md +++ b/docs/generators/apache2.md @@ -3,6 +3,8 @@ title: Config Options for apache2 sidebar_label: apache2 --- +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| diff --git a/docs/generators/apex.md b/docs/generators/apex.md index 31e666618c5ef19a57a1f5dcaae95631386540e1..00f25f255cafdceff02aa3690d201d333584242c 100644 --- a/docs/generators/apex.md +++ b/docs/generators/apex.md @@ -3,6 +3,8 @@ title: Config Options for apex sidebar_label: apex --- +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| diff --git a/docs/generators/asciidoc.md b/docs/generators/asciidoc.md index e9ff8d86ca60f0d02d643ceb05da8a38f2f0ed1b..bf6eab0b9ebad952f3a9c32506d26647850c663d 100644 --- a/docs/generators/asciidoc.md +++ b/docs/generators/asciidoc.md @@ -3,6 +3,8 @@ title: Config Options for asciidoc sidebar_label: asciidoc --- +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| diff --git a/docs/generators/aspnetcore.md b/docs/generators/aspnetcore.md index c5d4207c765bdee903a0e5da8f379f7fed068e2c..b28410855f872962d4a81707bba1d23c6ba1d78e 100644 --- a/docs/generators/aspnetcore.md +++ b/docs/generators/aspnetcore.md @@ -3,6 +3,8 @@ title: Config Options for aspnetcore sidebar_label: aspnetcore --- +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 | | ------ | ----------- | ------ | ------- | |aspnetCoreVersion|ASP.NET Core version: 3.1, 3.0, 2.2, 2.1, 2.0 (deprecated)| |2.2| diff --git a/docs/generators/avro-schema.md b/docs/generators/avro-schema.md index 585482608fea2130a9fd0c1658fbfc74cb4a8223..d358217159190012c7056be493e3db1308ae123e 100644 --- a/docs/generators/avro-schema.md +++ b/docs/generators/avro-schema.md @@ -3,6 +3,8 @@ title: Config Options for avro-schema sidebar_label: avro-schema --- +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| diff --git a/docs/generators/bash.md b/docs/generators/bash.md index 3eb089386fa635db8e84fba2e7f3d4fca2e06ce5..6b089ce42604c9c1d7b38bd1294155ad5090571a 100644 --- a/docs/generators/bash.md +++ b/docs/generators/bash.md @@ -3,6 +3,8 @@ title: Config Options for bash sidebar_label: bash --- +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| diff --git a/docs/generators/c.md b/docs/generators/c.md index 0fdf91d1843f2dfccbdd7f0ef015fddf55dff533..6dac18478fd1cd0c7e635fbbbea08fd2b9c3c266 100644 --- a/docs/generators/c.md +++ b/docs/generators/c.md @@ -3,6 +3,8 @@ title: Config Options for c sidebar_label: c --- +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| diff --git a/docs/generators/clojure.md b/docs/generators/clojure.md index 69acb89fee6aebfd7f92f749cb3963083c1c9352..8b8338ecf493f3ae14c74729bfdaf95c3f8c58ce 100644 --- a/docs/generators/clojure.md +++ b/docs/generators/clojure.md @@ -3,6 +3,8 @@ title: Config Options for clojure sidebar_label: clojure --- +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| diff --git a/docs/generators/cpp-pistache-server.md b/docs/generators/cpp-pistache-server.md index 88bcbe76f8eca81dc9172406c135e91f568e7bb4..0e4046ec566528252aba229314f57fae8d62c45c 100644 --- a/docs/generators/cpp-pistache-server.md +++ b/docs/generators/cpp-pistache-server.md @@ -3,6 +3,8 @@ title: Config Options for cpp-pistache-server sidebar_label: cpp-pistache-server --- +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 | | ------ | ----------- | ------ | ------- | |addExternalLibs|Add the Possibility to fetch and compile external Libraries needed by this Framework.| |true| diff --git a/docs/generators/cpp-qt5-client.md b/docs/generators/cpp-qt5-client.md index 4792d7a678afc7662054bb03fe910a444a9f4b59..2258aa2535e968adb3cc0d12abf2738eb4bbb6ec 100644 --- a/docs/generators/cpp-qt5-client.md +++ b/docs/generators/cpp-qt5-client.md @@ -3,6 +3,8 @@ title: Config Options for cpp-qt5-client sidebar_label: cpp-qt5-client --- +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| diff --git a/docs/generators/cpp-qt5-qhttpengine-server.md b/docs/generators/cpp-qt5-qhttpengine-server.md index 50a290931bf1ab2fd5f54107d62837442ea5be62..3f4632d0b47c829b03ea08cff078e2801487e25c 100644 --- a/docs/generators/cpp-qt5-qhttpengine-server.md +++ b/docs/generators/cpp-qt5-qhttpengine-server.md @@ -3,6 +3,8 @@ title: Config Options for cpp-qt5-qhttpengine-server sidebar_label: cpp-qt5-qhttpengine-server --- +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| diff --git a/docs/generators/cpp-restbed-server.md b/docs/generators/cpp-restbed-server.md index d30b18b988400dbb7b2babd53e42be20ac1464a4..4683a9be64b914715c03f9fc81df30dcf3d22c2c 100644 --- a/docs/generators/cpp-restbed-server.md +++ b/docs/generators/cpp-restbed-server.md @@ -3,6 +3,8 @@ title: Config Options for cpp-restbed-server sidebar_label: cpp-restbed-server --- +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 | | ------ | ----------- | ------ | ------- | |apiPackage|C++ namespace for apis (convention: name.space.api).| |org.openapitools.server.api| diff --git a/docs/generators/cpp-restsdk.md b/docs/generators/cpp-restsdk.md index cb70cea8225c7766b7463e4f31e98ae9cd70c09f..9dfbb390514c6784ea64f115b90772d619d4d6ab 100644 --- a/docs/generators/cpp-restsdk.md +++ b/docs/generators/cpp-restsdk.md @@ -3,6 +3,8 @@ title: Config Options for cpp-restsdk sidebar_label: cpp-restsdk --- +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 | | ------ | ----------- | ------ | ------- | |apiPackage|C++ namespace for apis (convention: name.space.api).| |org.openapitools.client.api| diff --git a/docs/generators/cpp-tizen.md b/docs/generators/cpp-tizen.md index e39c66ddb5a85969bd1f649620209828a338d1ab..ce44d3384bfd20222796b0c3960255d74d60cdaa 100644 --- a/docs/generators/cpp-tizen.md +++ b/docs/generators/cpp-tizen.md @@ -3,6 +3,8 @@ title: Config Options for cpp-tizen sidebar_label: cpp-tizen --- +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| diff --git a/docs/generators/cpp-ue4.md b/docs/generators/cpp-ue4.md index 1b8100b882d38e7e32f0e3f92d2bce922bd6cf85..8ff6e11f990df56a0a434c5a9c966d7c63cc7863 100644 --- a/docs/generators/cpp-ue4.md +++ b/docs/generators/cpp-ue4.md @@ -3,6 +3,8 @@ title: Config Options for cpp-ue4 sidebar_label: cpp-ue4 --- +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| diff --git a/docs/generators/csharp-dotnet2.md b/docs/generators/csharp-dotnet2.md index 9e6175a7bfd0557b194c502243138885f16430db..3b5cee05e30eee2e6402fdf997de8a3931e1dece 100644 --- a/docs/generators/csharp-dotnet2.md +++ b/docs/generators/csharp-dotnet2.md @@ -3,6 +3,8 @@ title: Config Options for csharp-dotnet2 sidebar_label: csharp-dotnet2 --- +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 | | ------ | ----------- | ------ | ------- | |clientPackage|C# client package name (convention: Camel.Case).| |Org.OpenAPITools.Client| diff --git a/docs/generators/csharp-nancyfx.md b/docs/generators/csharp-nancyfx.md index 3d2b030d568874162b43e95fa5625edbf76f2fde..537db8e94c926f660099a2246e84dba27e1c3996 100644 --- a/docs/generators/csharp-nancyfx.md +++ b/docs/generators/csharp-nancyfx.md @@ -3,6 +3,8 @@ title: Config Options for csharp-nancyfx sidebar_label: csharp-nancyfx --- +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 | | ------ | ----------- | ------ | ------- | |asyncServer|Set to true to enable the generation of async routes/endpoints.| |false| diff --git a/docs/generators/csharp-netcore.md b/docs/generators/csharp-netcore.md index 28218b990e0f6c2bf60b4b28fa7893b4ce22407b..fe7594a243b267dcc9b6a5c0f522987ca12c0fc8 100644 --- a/docs/generators/csharp-netcore.md +++ b/docs/generators/csharp-netcore.md @@ -3,6 +3,8 @@ title: Config Options for csharp-netcore sidebar_label: csharp-netcore --- +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| diff --git a/docs/generators/csharp.md b/docs/generators/csharp.md index 3b667b8cd85efd9423cdc3262ba28cdbf1dae09b..663bc7c5d0fa378aba4112674af7733fde5e29a7 100644 --- a/docs/generators/csharp.md +++ b/docs/generators/csharp.md @@ -3,6 +3,8 @@ title: Config Options for csharp sidebar_label: csharp --- +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| diff --git a/docs/generators/cwiki.md b/docs/generators/cwiki.md index 403e7fcae96fc45387b7328fa01579273a636c06..72a31cd525fb555031a95d43efade0ce2c5fb263 100644 --- a/docs/generators/cwiki.md +++ b/docs/generators/cwiki.md @@ -3,6 +3,8 @@ title: Config Options for cwiki sidebar_label: cwiki --- +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| diff --git a/docs/generators/dart-dio.md b/docs/generators/dart-dio.md index 653d6ef473de201b26a25c66565483252cd45ab3..39e509e6b9f575331ac94828d08a052b092799e6 100644 --- a/docs/generators/dart-dio.md +++ b/docs/generators/dart-dio.md @@ -3,6 +3,8 @@ title: Config Options for dart-dio sidebar_label: dart-dio --- +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| diff --git a/docs/generators/dart-jaguar.md b/docs/generators/dart-jaguar.md index d4430311aed43883ba09594213aef2984655420d..eb92db2c764fa8b0b296f7a22a6ae07ac914b068 100644 --- a/docs/generators/dart-jaguar.md +++ b/docs/generators/dart-jaguar.md @@ -3,6 +3,8 @@ title: Config Options for dart-jaguar sidebar_label: dart-jaguar --- +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| diff --git a/docs/generators/dart.md b/docs/generators/dart.md index ea44c79ed38c583c28a27a961d05a3c2d15bf58a..4995b0a331079b6a7a75b995a87a8ad9ed661dd9 100644 --- a/docs/generators/dart.md +++ b/docs/generators/dart.md @@ -3,6 +3,8 @@ title: Config Options for dart sidebar_label: dart --- +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| diff --git a/docs/generators/dynamic-html.md b/docs/generators/dynamic-html.md index 901e797c520901d69ce6a45a388fec5dcea5f0bc..b146e47b2006ee484549ebe1e0bf178d8d2a8336 100644 --- a/docs/generators/dynamic-html.md +++ b/docs/generators/dynamic-html.md @@ -3,6 +3,8 @@ title: Config Options for dynamic-html sidebar_label: dynamic-html --- +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| diff --git a/docs/generators/eiffel.md b/docs/generators/eiffel.md index dae9373b25fc44f4f724e054f62057824d9394ed..668164352bd8e432962c1674bbb38224b58ca239 100644 --- a/docs/generators/eiffel.md +++ b/docs/generators/eiffel.md @@ -3,6 +3,8 @@ title: Config Options for eiffel sidebar_label: eiffel --- +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 | | ------ | ----------- | ------ | ------- | |hideGenerationTimestamp|Hides the generation timestamp when files are generated.| |true| diff --git a/docs/generators/elixir.md b/docs/generators/elixir.md index 0e077ce9d65916a9a7bc4fe85252b5b56cb79fa5..f475840400d5ed4a86fcaf021748ec8910022839 100644 --- a/docs/generators/elixir.md +++ b/docs/generators/elixir.md @@ -3,6 +3,8 @@ title: Config Options for elixir sidebar_label: elixir --- +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| diff --git a/docs/generators/elm.md b/docs/generators/elm.md index 2208ade10631b3349a0a78eeb8f3fda337adc793..73b67667616f6d32f5dd33ee3237f7b267181294 100644 --- a/docs/generators/elm.md +++ b/docs/generators/elm.md @@ -3,6 +3,8 @@ title: Config Options for elm sidebar_label: elm --- +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 | | ------ | ----------- | ------ | ------- | diff --git a/docs/generators/erlang-client.md b/docs/generators/erlang-client.md index ffbd3301a98400ecf5197a51087c1c4b464db73b..225eaebe8bbfb35758d711de538fe6e3a4721372 100644 --- a/docs/generators/erlang-client.md +++ b/docs/generators/erlang-client.md @@ -3,6 +3,8 @@ title: Config Options for erlang-client sidebar_label: erlang-client --- +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 | | ------ | ----------- | ------ | ------- | |packageName|Erlang application name (convention: lowercase).| |openapi| diff --git a/docs/generators/erlang-proper.md b/docs/generators/erlang-proper.md index 0cb48d844cf9c1255167fed3972953145806b922..05e90e712358ebfabd70d337ec900e11395448f2 100644 --- a/docs/generators/erlang-proper.md +++ b/docs/generators/erlang-proper.md @@ -3,6 +3,8 @@ title: Config Options for erlang-proper sidebar_label: erlang-proper --- +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 | | ------ | ----------- | ------ | ------- | |packageName|Erlang application name (convention: lowercase).| |openapi| diff --git a/docs/generators/erlang-server.md b/docs/generators/erlang-server.md index 92aa5b3c16819f129b1d7fa9a6cecb27b730e0af..e9c35f8fe856304527ae9e3b7838379738db6969 100644 --- a/docs/generators/erlang-server.md +++ b/docs/generators/erlang-server.md @@ -3,6 +3,8 @@ title: Config Options for erlang-server sidebar_label: erlang-server --- +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 | | ------ | ----------- | ------ | ------- | |openAPISpecName|Openapi Spec Name.| |openapi| diff --git a/docs/generators/flash-deprecated.md b/docs/generators/flash-deprecated.md index 115553132999243a9b9aada7ff82f0c3dd5d7466..5330b928fa4a953db1a08486be186f0bbd61fc39 100644 --- a/docs/generators/flash-deprecated.md +++ b/docs/generators/flash-deprecated.md @@ -3,6 +3,8 @@ title: Config Options for flash-deprecated sidebar_label: flash-deprecated --- +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 | | ------ | ----------- | ------ | ------- | |invokerPackage|root package for generated code| |null| diff --git a/docs/generators/fsharp-functions.md b/docs/generators/fsharp-functions.md index 12e76c3e4f4e2ac74ed552f4335aa302b0c50ae7..78a80118ea32ef7c375c12c621cddb8f69c66b6b 100644 --- a/docs/generators/fsharp-functions.md +++ b/docs/generators/fsharp-functions.md @@ -3,6 +3,8 @@ title: Config Options for fsharp-functions sidebar_label: fsharp-functions --- +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| diff --git a/docs/generators/fsharp-giraffe-server.md b/docs/generators/fsharp-giraffe-server.md index 1554abf9f2ad9c547a5032da7492ddf0e79c6446..f374168aa71f54c5b49f836897e24a9c3a1260d5 100644 --- a/docs/generators/fsharp-giraffe-server.md +++ b/docs/generators/fsharp-giraffe-server.md @@ -3,6 +3,8 @@ title: Config Options for fsharp-giraffe-server sidebar_label: fsharp-giraffe-server --- +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 | | ------ | ----------- | ------ | ------- | |buildTarget|Target the build for a program or library.| |program| diff --git a/docs/generators/go-deprecated.md b/docs/generators/go-deprecated.md index 7e8619c889a61aa504e35ca3ef27c8bbc1fb6800..4faa3a8b636d876ba207089db07af3de104c1f5a 100644 --- a/docs/generators/go-deprecated.md +++ b/docs/generators/go-deprecated.md @@ -3,6 +3,8 @@ title: Config Options for go-deprecated sidebar_label: go-deprecated --- +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 | | ------ | ----------- | ------ | ------- | |enumClassPrefix|Prefix enum with class name| |false| diff --git a/docs/generators/go-gin-server.md b/docs/generators/go-gin-server.md index 4e26377ec198c9e4eb4ee4ea8b11aff201d71920..85e24728f1e9a4cd0eb4c20f4e736668ee45df3b 100644 --- a/docs/generators/go-gin-server.md +++ b/docs/generators/go-gin-server.md @@ -3,6 +3,8 @@ title: Config Options for go-gin-server sidebar_label: go-gin-server --- +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 | | ------ | ----------- | ------ | ------- | |apiPath|Name of the folder that contains the Go source code| |go| diff --git a/docs/generators/go-server.md b/docs/generators/go-server.md index f19d4b519963f7ca091a3e7553d2155509225276..e0abd3de52c294d465b34eeb6aad4c99a7242d8f 100644 --- a/docs/generators/go-server.md +++ b/docs/generators/go-server.md @@ -3,6 +3,8 @@ title: Config Options for go-server sidebar_label: go-server --- +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 | | ------ | ----------- | ------ | ------- | |enumClassPrefix|Prefix enum with class name| |false| diff --git a/docs/generators/go.md b/docs/generators/go.md index ea42c12988c88e1ef4e42390ad006aa80496af58..21883f9995db69cb3aeefadf38a6408b0704ba9a 100644 --- a/docs/generators/go.md +++ b/docs/generators/go.md @@ -3,6 +3,8 @@ title: Config Options for go sidebar_label: go --- +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 | | ------ | ----------- | ------ | ------- | |disallowAdditionalPropertiesIfNotPresent|Specify the behavior when the 'additionalProperties' keyword is not present in the OAS document. If false: the 'additionalProperties' implementation is compliant with the OAS and JSON schema specifications. If true: when the 'additionalProperties' keyword is not present in a schema, the value of 'additionalProperties' is set to false, i.e. no additional properties are allowed. Note: this mode is not compliant with the JSON schema specification. This is the original openapi-generator behavior.This setting is currently ignored for OAS 2.0 documents: 1) When the 'additionalProperties' keyword is not present in a 2.0 schema, additional properties are NOT allowed. 2) Boolean values of the 'additionalProperties' keyword are ignored. It's as if additional properties are NOT allowed.Note: the root cause are issues #1369 and #1371, which must be resolved in the swagger-parser project.|<dl><dt>**false**</dt><dd>The 'additionalProperties' implementation is compliant with the OAS and JSON schema specifications.</dd><dt>**true**</dt><dd>when the 'additionalProperties' keyword is not present in a schema, the value of 'additionalProperties' is automatically set to false, i.e. no additional properties are allowed. Note: this mode is not compliant with the JSON schema specification. This is the original openapi-generator behavior.</dd></dl>|true| diff --git a/docs/generators/graphql-nodejs-express-server.md b/docs/generators/graphql-nodejs-express-server.md index 050142f89b397b537116058beed47d5a6dbbc8d9..20eda0bb6c32169a212445b15f50968588949dde 100644 --- a/docs/generators/graphql-nodejs-express-server.md +++ b/docs/generators/graphql-nodejs-express-server.md @@ -3,6 +3,8 @@ title: Config Options for graphql-nodejs-express-server sidebar_label: graphql-nodejs-express-server --- +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 | | ------ | ----------- | ------ | ------- | |hideGenerationTimestamp|Hides the generation timestamp when files are generated.| |true| diff --git a/docs/generators/graphql-schema.md b/docs/generators/graphql-schema.md index 0ae8e628fe80da0e94d388f6c4780859d3d01467..b64d9576599acf6594e718241b9d875aad03a4f8 100644 --- a/docs/generators/graphql-schema.md +++ b/docs/generators/graphql-schema.md @@ -3,6 +3,8 @@ title: Config Options for graphql-schema sidebar_label: graphql-schema --- +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 | | ------ | ----------- | ------ | ------- | |hideGenerationTimestamp|Hides the generation timestamp when files are generated.| |true| diff --git a/docs/generators/groovy.md b/docs/generators/groovy.md index 4dd1f414a89da9bcbc403e015c685b1c09d3bb84..8f48ab64c0b12e88f9090a7f772c8e7b5a9fde84 100644 --- a/docs/generators/groovy.md +++ b/docs/generators/groovy.md @@ -3,6 +3,8 @@ title: Config Options for groovy sidebar_label: groovy --- +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 | | ------ | ----------- | ------ | ------- | |additionalModelTypeAnnotations|Additional annotations for model type(class level annotations)| |null| diff --git a/docs/generators/haskell-http-client.md b/docs/generators/haskell-http-client.md index d0e161bab26760e4c4a5f4079bb6645068e86af0..09d152af0d8407c7f0305368ca8f84e1638f40b1 100644 --- a/docs/generators/haskell-http-client.md +++ b/docs/generators/haskell-http-client.md @@ -3,6 +3,8 @@ title: Config Options for haskell-http-client sidebar_label: haskell-http-client --- +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 | | ------ | ----------- | ------ | ------- | |allowFromJsonNulls|allow JSON Null during model decoding from JSON| |true| diff --git a/docs/generators/haskell.md b/docs/generators/haskell.md index 9d0a3e70085f467e58bff04951fdc3fad41db4c7..17b7b891abeaf8f77eaaacfd42e5188900f8fc52 100644 --- a/docs/generators/haskell.md +++ b/docs/generators/haskell.md @@ -3,6 +3,8 @@ title: Config Options for haskell sidebar_label: haskell --- +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| diff --git a/docs/generators/html.md b/docs/generators/html.md index e364221ebbdd6ef4443066db57a89d012a8545e9..16774bf39322f64092284d27399079d710e0838a 100644 --- a/docs/generators/html.md +++ b/docs/generators/html.md @@ -3,6 +3,8 @@ title: Config Options for html sidebar_label: html --- +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| diff --git a/docs/generators/html2.md b/docs/generators/html2.md index 978015e37ee66ae053450425bb313059f8640ab5..a37b319931ddcc7cb6876c38390147591d0611be 100644 --- a/docs/generators/html2.md +++ b/docs/generators/html2.md @@ -3,6 +3,8 @@ title: Config Options for html2 sidebar_label: html2 --- +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| diff --git a/docs/generators/java-inflector.md b/docs/generators/java-inflector.md index 7982437c1a79f6f7bffef4e77a1d2d24467d3c68..cd6cb8880f36c93cc3c388dfbb7f22d9ed5ab63f 100644 --- a/docs/generators/java-inflector.md +++ b/docs/generators/java-inflector.md @@ -3,6 +3,8 @@ title: Config Options for java-inflector sidebar_label: java-inflector --- +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 | | ------ | ----------- | ------ | ------- | |additionalModelTypeAnnotations|Additional annotations for model type(class level annotations)| |null| diff --git a/docs/generators/java-msf4j.md b/docs/generators/java-msf4j.md index 40c9fb24935f5179410c266202747b57bc2b3ceb..2728cc4afad5ed80ccc6a446d45d74f40c811a4d 100644 --- a/docs/generators/java-msf4j.md +++ b/docs/generators/java-msf4j.md @@ -3,6 +3,8 @@ title: Config Options for java-msf4j sidebar_label: java-msf4j --- +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 | | ------ | ----------- | ------ | ------- | |additionalModelTypeAnnotations|Additional annotations for model type(class level annotations)| |null| diff --git a/docs/generators/java-pkmst.md b/docs/generators/java-pkmst.md index ac610a825c691ed55ab46437b72a5d1dd38fea50..fcc8585cce8362d9f8aa48a50ff0d71f4b7e3558 100644 --- a/docs/generators/java-pkmst.md +++ b/docs/generators/java-pkmst.md @@ -3,6 +3,8 @@ title: Config Options for java-pkmst sidebar_label: java-pkmst --- +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 | | ------ | ----------- | ------ | ------- | |additionalModelTypeAnnotations|Additional annotations for model type(class level annotations)| |null| diff --git a/docs/generators/java-play-framework.md b/docs/generators/java-play-framework.md index 0650ed1b88952d638abfce1847a8dc438520534e..98cccb0cbdfd66aac371c666f307a4acb1380ecb 100644 --- a/docs/generators/java-play-framework.md +++ b/docs/generators/java-play-framework.md @@ -3,6 +3,8 @@ title: Config Options for java-play-framework sidebar_label: java-play-framework --- +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 | | ------ | ----------- | ------ | ------- | |additionalModelTypeAnnotations|Additional annotations for model type(class level annotations)| |null| diff --git a/docs/generators/java-undertow-server.md b/docs/generators/java-undertow-server.md index a9dcb53d636eeb4f1a1c3308f504e45e6ece88c0..325d0eb23e24daceff9a473a04a826b185f7f66f 100644 --- a/docs/generators/java-undertow-server.md +++ b/docs/generators/java-undertow-server.md @@ -3,6 +3,8 @@ title: Config Options for java-undertow-server sidebar_label: java-undertow-server --- +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 | | ------ | ----------- | ------ | ------- | |additionalModelTypeAnnotations|Additional annotations for model type(class level annotations)| |null| diff --git a/docs/generators/java-vertx-web.md b/docs/generators/java-vertx-web.md index 0d3e7499362cd3b21338edf752bdab9c6e1a21e2..ad80dc990b30717d3bbf94769e2014d43cd1dd9e 100644 --- a/docs/generators/java-vertx-web.md +++ b/docs/generators/java-vertx-web.md @@ -3,6 +3,8 @@ title: Config Options for java-vertx-web sidebar_label: java-vertx-web --- +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 | | ------ | ----------- | ------ | ------- | |additionalModelTypeAnnotations|Additional annotations for model type(class level annotations)| |null| diff --git a/docs/generators/java-vertx.md b/docs/generators/java-vertx.md index 7186a6cae6309618b5720f70efa09fe87129ab10..f65cd6ccdedde633fba45f5a263955b507e3ba2d 100644 --- a/docs/generators/java-vertx.md +++ b/docs/generators/java-vertx.md @@ -3,6 +3,8 @@ title: Config Options for java-vertx sidebar_label: java-vertx --- +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 | | ------ | ----------- | ------ | ------- | |additionalModelTypeAnnotations|Additional annotations for model type(class level annotations)| |null| diff --git a/docs/generators/java.md b/docs/generators/java.md index e951671ac6865ad7f2a788fd16dbca95049ac5e9..5d258a98568ffec2a33bd6ec20a1f54f057b1117 100644 --- a/docs/generators/java.md +++ b/docs/generators/java.md @@ -3,6 +3,8 @@ title: Config Options for java sidebar_label: java --- +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 | | ------ | ----------- | ------ | ------- | |additionalModelTypeAnnotations|Additional annotations for model type(class level annotations)| |null| diff --git a/docs/generators/javascript-apollo.md b/docs/generators/javascript-apollo.md index d4eb3c5ef190ebd80a371a217d6db75f27b64043..bfeab1a9cdf0eb425fbcca0079b73554f26c85e8 100644 --- a/docs/generators/javascript-apollo.md +++ b/docs/generators/javascript-apollo.md @@ -3,6 +3,8 @@ title: Config Options for javascript-apollo sidebar_label: javascript-apollo --- +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| diff --git a/docs/generators/javascript-closure-angular.md b/docs/generators/javascript-closure-angular.md index 73d032be478c3aa9e8c6eeee97a696f8e9b83dde..57c05bea77c8cdbb9fffba670b1fba9e72d880dc 100644 --- a/docs/generators/javascript-closure-angular.md +++ b/docs/generators/javascript-closure-angular.md @@ -3,6 +3,8 @@ title: Config Options for javascript-closure-angular sidebar_label: javascript-closure-angular --- +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| diff --git a/docs/generators/javascript-flowtyped.md b/docs/generators/javascript-flowtyped.md index 7615018ca0a00b2da9c73285e38bdc847bd249ca..1e8585d234ed0114e67e1ea921a5892723cfc9b2 100644 --- a/docs/generators/javascript-flowtyped.md +++ b/docs/generators/javascript-flowtyped.md @@ -3,6 +3,8 @@ title: Config Options for javascript-flowtyped sidebar_label: javascript-flowtyped --- +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| diff --git a/docs/generators/javascript.md b/docs/generators/javascript.md index 2e5ff08df5b70b08f407f51880b8cbab91731a68..6c319af5fecb0bddbdfd73293e50463333e79e29 100644 --- a/docs/generators/javascript.md +++ b/docs/generators/javascript.md @@ -3,6 +3,8 @@ title: Config Options for javascript sidebar_label: javascript --- +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| diff --git a/docs/generators/jaxrs-cxf-cdi.md b/docs/generators/jaxrs-cxf-cdi.md index 02861221b0cf6ccee1c6ad952485101d6db88c0c..2bf760d692f5d8cbc56c736759e14c8ddbedc12a 100644 --- a/docs/generators/jaxrs-cxf-cdi.md +++ b/docs/generators/jaxrs-cxf-cdi.md @@ -3,6 +3,8 @@ title: Config Options for jaxrs-cxf-cdi sidebar_label: jaxrs-cxf-cdi --- +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 | | ------ | ----------- | ------ | ------- | |additionalModelTypeAnnotations|Additional annotations for model type(class level annotations)| |null| diff --git a/docs/generators/jaxrs-cxf-client.md b/docs/generators/jaxrs-cxf-client.md index 72167b95199c152d71123787a0429d4ea28410d6..00a7802804c24914d1a70a9615db17bf3cd2d81d 100644 --- a/docs/generators/jaxrs-cxf-client.md +++ b/docs/generators/jaxrs-cxf-client.md @@ -3,6 +3,8 @@ title: Config Options for jaxrs-cxf-client sidebar_label: jaxrs-cxf-client --- +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 | | ------ | ----------- | ------ | ------- | |additionalModelTypeAnnotations|Additional annotations for model type(class level annotations)| |null| diff --git a/docs/generators/jaxrs-cxf-extended.md b/docs/generators/jaxrs-cxf-extended.md index 50851c3de016fcecd871a8036e3330ec741644ec..4fc2d41055aaf65f2b4a6ecb02c75df6d2b3de91 100644 --- a/docs/generators/jaxrs-cxf-extended.md +++ b/docs/generators/jaxrs-cxf-extended.md @@ -3,6 +3,8 @@ title: Config Options for jaxrs-cxf-extended sidebar_label: jaxrs-cxf-extended --- +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 | | ------ | ----------- | ------ | ------- | |addConsumesProducesJson|Add @Consumes/@Produces Json to API interface| |false| diff --git a/docs/generators/jaxrs-cxf.md b/docs/generators/jaxrs-cxf.md index 509dfbc61c55099c669b982ad6f81d61ba5f2c8d..ee2a3f214c863a36cccdceddc5633754a47006db 100644 --- a/docs/generators/jaxrs-cxf.md +++ b/docs/generators/jaxrs-cxf.md @@ -3,6 +3,8 @@ title: Config Options for jaxrs-cxf sidebar_label: jaxrs-cxf --- +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 | | ------ | ----------- | ------ | ------- | |addConsumesProducesJson|Add @Consumes/@Produces Json to API interface| |false| diff --git a/docs/generators/jaxrs-jersey.md b/docs/generators/jaxrs-jersey.md index 32b151ade989570a4c143b3ddc0873d00a0a03b1..056afbe7663b8d1e64be1344710f43aaff24ac1a 100644 --- a/docs/generators/jaxrs-jersey.md +++ b/docs/generators/jaxrs-jersey.md @@ -3,6 +3,8 @@ title: Config Options for jaxrs-jersey sidebar_label: jaxrs-jersey --- +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 | | ------ | ----------- | ------ | ------- | |additionalModelTypeAnnotations|Additional annotations for model type(class level annotations)| |null| diff --git a/docs/generators/jaxrs-resteasy-eap.md b/docs/generators/jaxrs-resteasy-eap.md index db791652f1572661aba69c0e6b69767de8c70bb6..24b64e1da9aec2a5b6469e1c3ee5443c12068b8d 100644 --- a/docs/generators/jaxrs-resteasy-eap.md +++ b/docs/generators/jaxrs-resteasy-eap.md @@ -3,6 +3,8 @@ title: Config Options for jaxrs-resteasy-eap sidebar_label: jaxrs-resteasy-eap --- +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 | | ------ | ----------- | ------ | ------- | |additionalModelTypeAnnotations|Additional annotations for model type(class level annotations)| |null| diff --git a/docs/generators/jaxrs-resteasy.md b/docs/generators/jaxrs-resteasy.md index 44c957929a90c2ba278a3ef90a0228dc6b535f72..16423eae7d6435cc57d82e2a1d7b76194b5e4a9c 100644 --- a/docs/generators/jaxrs-resteasy.md +++ b/docs/generators/jaxrs-resteasy.md @@ -3,6 +3,8 @@ title: Config Options for jaxrs-resteasy sidebar_label: jaxrs-resteasy --- +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 | | ------ | ----------- | ------ | ------- | |additionalModelTypeAnnotations|Additional annotations for model type(class level annotations)| |null| diff --git a/docs/generators/jaxrs-spec.md b/docs/generators/jaxrs-spec.md index a88bc00bbda9c283fed5cd95f570e3c3cb1a0395..1b125b6f11807d4cba26ce471fdc6e9c25b5c2ec 100644 --- a/docs/generators/jaxrs-spec.md +++ b/docs/generators/jaxrs-spec.md @@ -3,6 +3,8 @@ title: Config Options for jaxrs-spec sidebar_label: jaxrs-spec --- +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 | | ------ | ----------- | ------ | ------- | |additionalModelTypeAnnotations|Additional annotations for model type(class level annotations)| |null| diff --git a/docs/generators/jmeter.md b/docs/generators/jmeter.md index 0a9c0d02d070ed0cfe8bf3d0138fc96a02e27999..f5bc72e14b297afe0d9126c652bdf94848d7bd64 100644 --- a/docs/generators/jmeter.md +++ b/docs/generators/jmeter.md @@ -3,6 +3,8 @@ title: Config Options for jmeter sidebar_label: jmeter --- +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| diff --git a/docs/generators/k6.md b/docs/generators/k6.md index 08505b7477e6cb1d06888f65e2fd0b2bd29da81f..12a596f78acec5399ac1aa9660c8e16938c57603 100644 --- a/docs/generators/k6.md +++ b/docs/generators/k6.md @@ -3,6 +3,8 @@ title: Config Options for k6 sidebar_label: k6 --- +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| diff --git a/docs/generators/kotlin-server.md b/docs/generators/kotlin-server.md index f1f405775415a05ff6e3291bf27b80252c5236ec..f474fbc741517f7604aa55042adf3d028b3370a8 100644 --- a/docs/generators/kotlin-server.md +++ b/docs/generators/kotlin-server.md @@ -3,6 +3,8 @@ title: Config Options for kotlin-server sidebar_label: kotlin-server --- +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 | | ------ | ----------- | ------ | ------- | |apiSuffix|suffix for api classes| |Api| diff --git a/docs/generators/kotlin-spring.md b/docs/generators/kotlin-spring.md index fad263186ab279acc2268942d4a919daa89268bf..4a0353d78991c8733b9b1b848224caa967e02be0 100644 --- a/docs/generators/kotlin-spring.md +++ b/docs/generators/kotlin-spring.md @@ -3,6 +3,8 @@ title: Config Options for kotlin-spring sidebar_label: kotlin-spring --- +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 | | ------ | ----------- | ------ | ------- | |apiPackage|api package for generated code| |org.openapitools.api| diff --git a/docs/generators/kotlin-vertx.md b/docs/generators/kotlin-vertx.md index cd1578baf44e57b618aa9592406632d9bcb6440a..cb0dbfe41cc1f308c338d2bbbd82e9dfb92de824 100644 --- a/docs/generators/kotlin-vertx.md +++ b/docs/generators/kotlin-vertx.md @@ -3,6 +3,8 @@ title: Config Options for kotlin-vertx sidebar_label: kotlin-vertx --- +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 | | ------ | ----------- | ------ | ------- | |apiSuffix|suffix for api classes| |Api| diff --git a/docs/generators/kotlin.md b/docs/generators/kotlin.md index c53f7f7a59dff162d9a5ab19bf5ac2bcbc491db9..e37648a9d6ad670585af7ec65e6d4a62fb0c22a0 100644 --- a/docs/generators/kotlin.md +++ b/docs/generators/kotlin.md @@ -3,6 +3,8 @@ title: Config Options for kotlin sidebar_label: kotlin --- +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 | | ------ | ----------- | ------ | ------- | |apiSuffix|suffix for api classes| |Api| diff --git a/docs/generators/lua.md b/docs/generators/lua.md index 6f372cbd04be5e390b47efeffd6e85b8da7642ee..6f9f4a80eaf5c0b067343db3225c242b8f80a80f 100644 --- a/docs/generators/lua.md +++ b/docs/generators/lua.md @@ -3,6 +3,8 @@ title: Config Options for lua sidebar_label: lua --- +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 | | ------ | ----------- | ------ | ------- | |hideGenerationTimestamp|Hides the generation timestamp when files are generated.| |true| diff --git a/docs/generators/markdown.md b/docs/generators/markdown.md index 143e109fd2a6728a75a34d3acfc5ece512d23377..d9eea806f93711470b07cc884e03865868d8671e 100644 --- a/docs/generators/markdown.md +++ b/docs/generators/markdown.md @@ -3,6 +3,8 @@ title: Config Options for markdown sidebar_label: markdown --- +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| diff --git a/docs/generators/mysql-schema.md b/docs/generators/mysql-schema.md index 7f12cc6969016616ec0a832e002e84dbd6fe7c02..8526ade4f0609a2f9b8271eae1cf9c52ffdf7f68 100644 --- a/docs/generators/mysql-schema.md +++ b/docs/generators/mysql-schema.md @@ -3,6 +3,8 @@ title: Config Options for mysql-schema sidebar_label: mysql-schema --- +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 | | ------ | ----------- | ------ | ------- | |defaultDatabaseName|Default database name for all MySQL queries| || diff --git a/docs/generators/nim.md b/docs/generators/nim.md index 8e513792751917557eb9ea1d0da3dc6f0ba9b1a9..eefaccac90a0417687ba94a6e0eb1c8aa99e14e0 100644 --- a/docs/generators/nim.md +++ b/docs/generators/nim.md @@ -3,6 +3,8 @@ title: Config Options for nim sidebar_label: nim --- +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| diff --git a/docs/generators/nodejs-express-server.md b/docs/generators/nodejs-express-server.md index 362f60b40c00ddb5308c0a1324c88dd46d103e86..2c35e5905805623987ffd882563521309ace2338 100644 --- a/docs/generators/nodejs-express-server.md +++ b/docs/generators/nodejs-express-server.md @@ -3,6 +3,8 @@ title: Config Options for nodejs-express-server sidebar_label: nodejs-express-server --- +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| diff --git a/docs/generators/objc.md b/docs/generators/objc.md index de53cd50ea677f17bb1b925a1d7b03cfdd9846ac..ad51253f978ad5123f94d00ff15498de711eae71 100644 --- a/docs/generators/objc.md +++ b/docs/generators/objc.md @@ -3,6 +3,8 @@ title: Config Options for objc sidebar_label: objc --- +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 | | ------ | ----------- | ------ | ------- | |authorEmail|Email to use in the podspec file.| |team@openapitools.org| diff --git a/docs/generators/ocaml.md b/docs/generators/ocaml.md index e2b2b1d518d324970a092a16bece2c66b50db608..020c9404f47ce389626f5d01fc0db3559b1256b1 100644 --- a/docs/generators/ocaml.md +++ b/docs/generators/ocaml.md @@ -3,6 +3,8 @@ title: Config Options for ocaml sidebar_label: ocaml --- +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| diff --git a/docs/generators/openapi-yaml.md b/docs/generators/openapi-yaml.md index 5d82b99ccbb19006b9c1a4fdc34a923d2aa15a35..7e895bb5d5cbc9173767d78041b105fad810d514 100644 --- a/docs/generators/openapi-yaml.md +++ b/docs/generators/openapi-yaml.md @@ -3,6 +3,8 @@ title: Config Options for openapi-yaml sidebar_label: openapi-yaml --- +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| diff --git a/docs/generators/openapi.md b/docs/generators/openapi.md index d2815cff29c54eb259bb6afa4209b4d11a6fee25..03dc722a2f8875c1fb440cc3e3552c918a201c26 100644 --- a/docs/generators/openapi.md +++ b/docs/generators/openapi.md @@ -3,6 +3,8 @@ title: Config Options for openapi sidebar_label: openapi --- +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| diff --git a/docs/generators/perl.md b/docs/generators/perl.md index a2e8ca6836cb1d18fe1a917dde88955c55737fba..910abd784325e2af5e22565a21f28c8987f2c61d 100644 --- a/docs/generators/perl.md +++ b/docs/generators/perl.md @@ -3,6 +3,8 @@ title: Config Options for perl sidebar_label: perl --- +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 | | ------ | ----------- | ------ | ------- | |ensureUniqueParams|Whether to ensure parameter names are unique in an operation (rename parameters that are not).| |true| diff --git a/docs/generators/php-laravel.md b/docs/generators/php-laravel.md index 61f4f5138b2f1245ace6e68ff96246fff654a3b6..25abdc13676673e0bf96722e99260523b4a6303c 100644 --- a/docs/generators/php-laravel.md +++ b/docs/generators/php-laravel.md @@ -3,6 +3,8 @@ title: Config Options for php-laravel sidebar_label: php-laravel --- +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| diff --git a/docs/generators/php-lumen.md b/docs/generators/php-lumen.md index 29739bfab45280ee891c8e06e112da26bb08e90f..4c6900199c80bc4255b812e3e50aa69913e660f7 100644 --- a/docs/generators/php-lumen.md +++ b/docs/generators/php-lumen.md @@ -3,6 +3,8 @@ title: Config Options for php-lumen sidebar_label: php-lumen --- +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| diff --git a/docs/generators/php-silex-deprecated.md b/docs/generators/php-silex-deprecated.md index 4019782c1c7b866bac8cd2c00625afebec916122..0651855af55559832ef627a18f73caf71b715903 100644 --- a/docs/generators/php-silex-deprecated.md +++ b/docs/generators/php-silex-deprecated.md @@ -3,6 +3,8 @@ title: Config Options for php-silex-deprecated sidebar_label: php-silex-deprecated --- +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| diff --git a/docs/generators/php-slim-deprecated.md b/docs/generators/php-slim-deprecated.md index d40c6b0308db5ee9f087cc1691151c86cd956f56..bc1d05dfe70388c790afe30b87efda50d2b35e7b 100644 --- a/docs/generators/php-slim-deprecated.md +++ b/docs/generators/php-slim-deprecated.md @@ -3,6 +3,8 @@ title: Config Options for php-slim-deprecated sidebar_label: php-slim-deprecated --- +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| diff --git a/docs/generators/php-slim4.md b/docs/generators/php-slim4.md index 15153acfd095b4066d16dd264d7306a6d2bdf7f4..93484686dc2a5d6900a9985bda465b96c6cc1f8f 100644 --- a/docs/generators/php-slim4.md +++ b/docs/generators/php-slim4.md @@ -3,6 +3,8 @@ title: Config Options for php-slim4 sidebar_label: php-slim4 --- +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| diff --git a/docs/generators/php-symfony.md b/docs/generators/php-symfony.md index 451ba2d59ded28e05b31ebd50dee2712eaaae379..be179ff4bd310fb4f1f6977574fc7c4296f594d2 100644 --- a/docs/generators/php-symfony.md +++ b/docs/generators/php-symfony.md @@ -3,6 +3,8 @@ title: Config Options for php-symfony sidebar_label: php-symfony --- +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| diff --git a/docs/generators/php-ze-ph.md b/docs/generators/php-ze-ph.md index a0fe342b3e2b7df118e8a1018eea741943bf4147..3d1f34d54ed54c752a8104b3b7d1b38f137770b2 100644 --- a/docs/generators/php-ze-ph.md +++ b/docs/generators/php-ze-ph.md @@ -3,6 +3,8 @@ title: Config Options for php-ze-ph sidebar_label: php-ze-ph --- +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| diff --git a/docs/generators/php.md b/docs/generators/php.md index 7923a3c89521d02fc364bcbe74393ebf8825be74..b3191b934786bda35fc363ebe075a9c4f7a3a661 100644 --- a/docs/generators/php.md +++ b/docs/generators/php.md @@ -3,6 +3,8 @@ title: Config Options for php sidebar_label: php --- +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| diff --git a/docs/generators/plantuml.md b/docs/generators/plantuml.md index df313bd1062f1c87d57a2e6a391f471862e2f4b3..1228a6860a972e8c310f9bb9653a363e555d6a0f 100644 --- a/docs/generators/plantuml.md +++ b/docs/generators/plantuml.md @@ -3,6 +3,8 @@ title: Config Options for plantuml sidebar_label: plantuml --- +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| diff --git a/docs/generators/powershell.md b/docs/generators/powershell.md index 03d638a3c8fa0918d7f157efd37edaf484c1166a..8d3d2820d7cd6c642fe6b20fd55f01aa75625a15 100644 --- a/docs/generators/powershell.md +++ b/docs/generators/powershell.md @@ -3,6 +3,8 @@ title: Config Options for powershell sidebar_label: powershell --- +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 | | ------ | ----------- | ------ | ------- | |apiNamePrefix|Prefix that will be appended to all PS objects. Default: empty string. e.g. Pet => PSPet.| |null| diff --git a/docs/generators/protobuf-schema.md b/docs/generators/protobuf-schema.md index a5836a73663ee415b5f63c854e2b733611e35579..104a47fe59cae87a2e4eb96d5bdccedb6b33df0c 100644 --- a/docs/generators/protobuf-schema.md +++ b/docs/generators/protobuf-schema.md @@ -3,6 +3,8 @@ title: Config Options for protobuf-schema sidebar_label: protobuf-schema --- +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 | | ------ | ----------- | ------ | ------- | diff --git a/docs/generators/python-aiohttp.md b/docs/generators/python-aiohttp.md index e9de567fe3c1818c6ff0a81a72c863e5ff47d9d3..a269b150f0d42a10214bee232a9ebad0d6ff107b 100644 --- a/docs/generators/python-aiohttp.md +++ b/docs/generators/python-aiohttp.md @@ -3,6 +3,8 @@ title: Config Options for python-aiohttp sidebar_label: python-aiohttp --- +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| diff --git a/docs/generators/python-blueplanet.md b/docs/generators/python-blueplanet.md index 737e67f1aac3b284179523eb61528447682e385e..f3607495f8ecf0496a0b2e5c5ca0fd68ae9152b4 100644 --- a/docs/generators/python-blueplanet.md +++ b/docs/generators/python-blueplanet.md @@ -3,6 +3,8 @@ title: Config Options for python-blueplanet sidebar_label: python-blueplanet --- +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| diff --git a/docs/generators/python-experimental.md b/docs/generators/python-experimental.md index c063b96dec8dc5b1db5ae9f0452225f5f6b6c293..309ab81e9a4003e6ee93f7d2c4da19742d59eb91 100644 --- a/docs/generators/python-experimental.md +++ b/docs/generators/python-experimental.md @@ -3,6 +3,8 @@ title: Config Options for python-experimental sidebar_label: python-experimental --- +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 | | ------ | ----------- | ------ | ------- | |generateSourceCodeOnly|Specifies that only a library source code is to be generated.| |false| diff --git a/docs/generators/python-flask.md b/docs/generators/python-flask.md index 6326bd49fb7ab87efb3943b15a762477c5bb89c9..e665eb34ba52e71cc368d3de695d28b3e39851ce 100644 --- a/docs/generators/python-flask.md +++ b/docs/generators/python-flask.md @@ -3,6 +3,8 @@ title: Config Options for python-flask sidebar_label: python-flask --- +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| diff --git a/docs/generators/python.md b/docs/generators/python.md index a56aa1530ed4ba7259a1fbd44b2a84f984c2c18b..f00e529e1f81402030028976d505903c75f2c967 100644 --- a/docs/generators/python.md +++ b/docs/generators/python.md @@ -3,6 +3,8 @@ title: Config Options for python sidebar_label: python --- +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 | | ------ | ----------- | ------ | ------- | |generateSourceCodeOnly|Specifies that only a library source code is to be generated.| |false| diff --git a/docs/generators/r.md b/docs/generators/r.md index 79bbb0bea069011736372191c38b8184cc23967e..696138356124051d9a43da5b4387bc420404f872 100644 --- a/docs/generators/r.md +++ b/docs/generators/r.md @@ -3,6 +3,8 @@ title: Config Options for r sidebar_label: r --- +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 | | ------ | ----------- | ------ | ------- | |exceptionPackage|Specify the exception handling package|<dl><dt>**default**</dt><dd>Use stop() for raising exceptions.</dd><dt>**rlang**</dt><dd>Use rlang package for exceptions.</dd></dl>|default| diff --git a/docs/generators/ruby-on-rails.md b/docs/generators/ruby-on-rails.md index ec34e9afddee0a6ba76d05a277fb45fd7f112177..b90e8757a90825f90d39c5301c29c3ad709f8386 100644 --- a/docs/generators/ruby-on-rails.md +++ b/docs/generators/ruby-on-rails.md @@ -3,6 +3,8 @@ title: Config Options for ruby-on-rails sidebar_label: ruby-on-rails --- +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 | | ------ | ----------- | ------ | ------- | |databaseAdapter|The adapter for database (e.g. mysql, sqlite). Default: sqlite| |sqlite| diff --git a/docs/generators/ruby-sinatra.md b/docs/generators/ruby-sinatra.md index ea23b05175fad9edb84aab4b1e097e3203229b5a..2d8b774dbea1eaf001d5064d7a6339f739bb5307 100644 --- a/docs/generators/ruby-sinatra.md +++ b/docs/generators/ruby-sinatra.md @@ -3,6 +3,8 @@ title: Config Options for ruby-sinatra sidebar_label: ruby-sinatra --- +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 | | ------ | ----------- | ------ | ------- | diff --git a/docs/generators/ruby.md b/docs/generators/ruby.md index 36fbb360363dafc6480b6191a98f45e95a37f008..141d0f8118e7d1facc4999cb4ae5d08dcd219788 100644 --- a/docs/generators/ruby.md +++ b/docs/generators/ruby.md @@ -3,6 +3,8 @@ title: Config Options for ruby sidebar_label: ruby --- +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| diff --git a/docs/generators/rust-server.md b/docs/generators/rust-server.md index a0e108d3069fb8f568c69395406c1d2ecbb58fb8..d24af6089b791b48006741b8a4373f5c96facc4d 100644 --- a/docs/generators/rust-server.md +++ b/docs/generators/rust-server.md @@ -3,6 +3,8 @@ title: Config Options for rust-server sidebar_label: rust-server --- +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 | | ------ | ----------- | ------ | ------- | |packageName|Rust crate name (convention: snake_case).| |openapi_client| diff --git a/docs/generators/rust.md b/docs/generators/rust.md index a98dbf462e1cc30cd197a6236c1bce400f7c5431..03febbd5fb00dc39bc3db9cc869c64a707203a05 100644 --- a/docs/generators/rust.md +++ b/docs/generators/rust.md @@ -3,6 +3,8 @@ title: Config Options for rust sidebar_label: rust --- +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 | | ------ | ----------- | ------ | ------- | |hideGenerationTimestamp|Hides the generation timestamp when files are generated.| |true| diff --git a/docs/generators/scala-akka-http-server.md b/docs/generators/scala-akka-http-server.md index 8d4427703ecdb892043bd1a0a63179d605d7541b..1e6f77a1dd6295501cc828ef8897ff746a2480a4 100644 --- a/docs/generators/scala-akka-http-server.md +++ b/docs/generators/scala-akka-http-server.md @@ -3,6 +3,8 @@ title: Config Options for scala-akka-http-server sidebar_label: scala-akka-http-server --- +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 | | ------ | ----------- | ------ | ------- | |akkaHttpVersion|The version of akka-http| |10.1.10| diff --git a/docs/generators/scala-akka.md b/docs/generators/scala-akka.md index d3be948ccd9fc16723e2caaef89839b5c6da14af..756be4dfc34633b80d62471747543afe1ca12170 100644 --- a/docs/generators/scala-akka.md +++ b/docs/generators/scala-akka.md @@ -3,6 +3,8 @@ title: Config Options for scala-akka sidebar_label: scala-akka --- +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| diff --git a/docs/generators/scala-finch.md b/docs/generators/scala-finch.md index c731772cb54392548d34186e0c883ee3f3864645..fcaa5a62c26c74e5599deef019789bfb252fab96 100644 --- a/docs/generators/scala-finch.md +++ b/docs/generators/scala-finch.md @@ -3,6 +3,8 @@ title: Config Options for scala-finch sidebar_label: scala-finch --- +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 | | ------ | ----------- | ------ | ------- | |apiPackage|package for generated api classes| |null| diff --git a/docs/generators/scala-gatling.md b/docs/generators/scala-gatling.md index 7115fb84a8fd921bd5789169994b4d83bd5c6ea1..4cc96bc6c95c7235ebccc39faf9cc2d0d21e1f64 100644 --- a/docs/generators/scala-gatling.md +++ b/docs/generators/scala-gatling.md @@ -3,6 +3,8 @@ title: Config Options for scala-gatling sidebar_label: scala-gatling --- +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| diff --git a/docs/generators/scala-httpclient-deprecated.md b/docs/generators/scala-httpclient-deprecated.md index d7ee388c3564d57d93465232436114ec740ebfcb..41b6bf8046c60436b8df5eaf395a1ec58319a9be 100644 --- a/docs/generators/scala-httpclient-deprecated.md +++ b/docs/generators/scala-httpclient-deprecated.md @@ -3,6 +3,8 @@ title: Config Options for scala-httpclient-deprecated sidebar_label: scala-httpclient-deprecated --- +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| diff --git a/docs/generators/scala-lagom-server.md b/docs/generators/scala-lagom-server.md index 96f452a6a088a25b7d8d05d920412fdc277f011c..dc3bc36f281f51dae5f14d061c079797cb68e6b6 100644 --- a/docs/generators/scala-lagom-server.md +++ b/docs/generators/scala-lagom-server.md @@ -3,6 +3,8 @@ title: Config Options for scala-lagom-server sidebar_label: scala-lagom-server --- +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| diff --git a/docs/generators/scala-play-server.md b/docs/generators/scala-play-server.md index 6783a03f4031235eb05b59e88a7a0b178ec3de89..ecd00b7651e5b57860d17f28c2ecfbceeedc135c 100644 --- a/docs/generators/scala-play-server.md +++ b/docs/generators/scala-play-server.md @@ -3,6 +3,8 @@ title: Config Options for scala-play-server sidebar_label: scala-play-server --- +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| diff --git a/docs/generators/scala-sttp.md b/docs/generators/scala-sttp.md index 45b7e9a0875105b825257bf95748d68e2af17c10..8222df26d853cb260d6c49ec2f063e2b3ce008a1 100644 --- a/docs/generators/scala-sttp.md +++ b/docs/generators/scala-sttp.md @@ -3,6 +3,8 @@ title: Config Options for scala-sttp sidebar_label: scala-sttp --- +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| diff --git a/docs/generators/scalatra.md b/docs/generators/scalatra.md index a7d3de36f751ad5752cf7ce1b93f12d575b412f8..2c8f7661579339885c25123dc3b679258cb54ef9 100644 --- a/docs/generators/scalatra.md +++ b/docs/generators/scalatra.md @@ -3,6 +3,8 @@ title: Config Options for scalatra sidebar_label: scalatra --- +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| diff --git a/docs/generators/scalaz.md b/docs/generators/scalaz.md index 6bcdd2126b966767cf5aab8277ed233c5fa545dd..73b4debc3b2b734ff1d0d46817faa9e25e6c46ca 100644 --- a/docs/generators/scalaz.md +++ b/docs/generators/scalaz.md @@ -3,6 +3,8 @@ title: Config Options for scalaz sidebar_label: scalaz --- +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| diff --git a/docs/generators/spring.md b/docs/generators/spring.md index fc3ea56b7da9efc087b941fb891cf26f43bd8dd1..19b3f1e75ef39a9b67218f91232007f2c835a52c 100644 --- a/docs/generators/spring.md +++ b/docs/generators/spring.md @@ -3,6 +3,8 @@ title: Config Options for spring sidebar_label: spring --- +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 | | ------ | ----------- | ------ | ------- | |additionalModelTypeAnnotations|Additional annotations for model type(class level annotations)| |null| diff --git a/docs/generators/swift4-deprecated.md b/docs/generators/swift4-deprecated.md index 956d1beac34202daa23b5cbf2e0ad5e6b0891460..a7faa8a27d6c680e97c976c9ff56bd5a46dd56d3 100644 --- a/docs/generators/swift4-deprecated.md +++ b/docs/generators/swift4-deprecated.md @@ -3,6 +3,8 @@ title: Config Options for swift4-deprecated sidebar_label: swift4-deprecated --- +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| diff --git a/docs/generators/swift5.md b/docs/generators/swift5.md index 8a2bf935fab1b42658b0385be47cd155062fbf22..fd5ac69ff1c97f55c76556548588d3c60d940c66 100644 --- a/docs/generators/swift5.md +++ b/docs/generators/swift5.md @@ -3,6 +3,8 @@ title: Config Options for swift5 sidebar_label: swift5 --- +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| diff --git a/docs/generators/typescript-angular.md b/docs/generators/typescript-angular.md index 64014fe7238e2b0f66d41fd0798e66abd3390970..d859d3f759b14ac6f3e851478e7e811ae95d5420 100644 --- a/docs/generators/typescript-angular.md +++ b/docs/generators/typescript-angular.md @@ -3,6 +3,8 @@ title: Config Options for typescript-angular sidebar_label: typescript-angular --- +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| diff --git a/docs/generators/typescript-angularjs-deprecated.md b/docs/generators/typescript-angularjs-deprecated.md index ad2c7aea207eb9ced2a86b6cc76df584c7be3d8f..5a859f986df81b93d82e3b83d1e40331c779fa96 100644 --- a/docs/generators/typescript-angularjs-deprecated.md +++ b/docs/generators/typescript-angularjs-deprecated.md @@ -3,6 +3,8 @@ title: Config Options for typescript-angularjs-deprecated sidebar_label: typescript-angularjs-deprecated --- +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| diff --git a/docs/generators/typescript-aurelia.md b/docs/generators/typescript-aurelia.md index 571c512b3672c1bd74ca1e968c8ad4f1ad10b2d0..51da119e7e3388e8b184325205c062e39c3a9c89 100644 --- a/docs/generators/typescript-aurelia.md +++ b/docs/generators/typescript-aurelia.md @@ -3,6 +3,8 @@ title: Config Options for typescript-aurelia sidebar_label: typescript-aurelia --- +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| diff --git a/docs/generators/typescript-axios.md b/docs/generators/typescript-axios.md index 320764ccf6dd85eecc9e510f9c6d4f0ae1887696..3b53d601ac08cebf3c20c7af0170a7ceb2392199 100644 --- a/docs/generators/typescript-axios.md +++ b/docs/generators/typescript-axios.md @@ -3,6 +3,8 @@ title: Config Options for typescript-axios sidebar_label: typescript-axios --- +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| diff --git a/docs/generators/typescript-fetch.md b/docs/generators/typescript-fetch.md index a39310fbc28cdde6f7569ee9aa1644a1b64fc290..6aa54572fa19cbc1654c4640f8567957c4ae788a 100644 --- a/docs/generators/typescript-fetch.md +++ b/docs/generators/typescript-fetch.md @@ -3,6 +3,8 @@ title: Config Options for typescript-fetch sidebar_label: typescript-fetch --- +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| diff --git a/docs/generators/typescript-inversify.md b/docs/generators/typescript-inversify.md index 68f0508b7336cf3e7106060cd8d9d688c4fadc53..3496f86d0dc81611adb08d667b36cb2134e0bb55 100644 --- a/docs/generators/typescript-inversify.md +++ b/docs/generators/typescript-inversify.md @@ -3,6 +3,8 @@ title: Config Options for typescript-inversify sidebar_label: typescript-inversify --- +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| diff --git a/docs/generators/typescript-jquery.md b/docs/generators/typescript-jquery.md index db0393ca006c355cae94942cf5fe167fd05c9c18..4e337ccd14bd9f1042d32304338dc60e5ba65abd 100644 --- a/docs/generators/typescript-jquery.md +++ b/docs/generators/typescript-jquery.md @@ -3,6 +3,8 @@ title: Config Options for typescript-jquery sidebar_label: typescript-jquery --- +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| diff --git a/docs/generators/typescript-node.md b/docs/generators/typescript-node.md index 64f6010a3e46de25ab4d260dd10fd12db76e1ed9..c37e351c4fd218652c011deeac6086bb1af20787 100644 --- a/docs/generators/typescript-node.md +++ b/docs/generators/typescript-node.md @@ -3,6 +3,8 @@ title: Config Options for typescript-node sidebar_label: typescript-node --- +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| diff --git a/docs/generators/typescript-redux-query.md b/docs/generators/typescript-redux-query.md index 01f970e7311596111eb4f7d86d29a599f2fa2dc6..558a684bf06dca2f00addd0e61cbc29dab1597f4 100644 --- a/docs/generators/typescript-redux-query.md +++ b/docs/generators/typescript-redux-query.md @@ -3,6 +3,8 @@ title: Config Options for typescript-redux-query sidebar_label: typescript-redux-query --- +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| diff --git a/docs/generators/typescript-rxjs.md b/docs/generators/typescript-rxjs.md index ce2adb8289f4923786f4194f5068fbc612574be4..7bd3cec0bb4bfdcf189b9a6912df73e06e0c12c4 100644 --- a/docs/generators/typescript-rxjs.md +++ b/docs/generators/typescript-rxjs.md @@ -3,6 +3,8 @@ title: Config Options for typescript-rxjs sidebar_label: typescript-rxjs --- +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| diff --git a/docs/generators/typescript.md b/docs/generators/typescript.md index db106fdb773da6858014f3062fc4b7e519952d25..fa4cf6aab662591054509de0fad3fdf9f05f6591 100644 --- a/docs/generators/typescript.md +++ b/docs/generators/typescript.md @@ -3,6 +3,8 @@ title: Config Options for typescript sidebar_label: typescript --- +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| diff --git a/modules/openapi-generator-cli/src/main/java/org/openapitools/codegen/cmd/ConfigHelp.java b/modules/openapi-generator-cli/src/main/java/org/openapitools/codegen/cmd/ConfigHelp.java index 7ad0e1ba709d01cd7487ee2f9a47c699b5dd5795..57eac7157124344350fb360b925a668b1699e65f 100644 --- a/modules/openapi-generator-cli/src/main/java/org/openapitools/codegen/cmd/ConfigHelp.java +++ b/modules/openapi-generator-cli/src/main/java/org/openapitools/codegen/cmd/ConfigHelp.java @@ -158,6 +158,9 @@ public class ConfigHelp extends OpenApiGeneratorCommand { sb.append("title: Config Options for ").append(generatorName).append(newline); sb.append("sidebar_label: ").append(generatorName).append(newline); sb.append("---").append(newline); + sb.append(newline); + sb.append("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."); + sb.append(newline); } else { sb.append(newline); sb.append("## CONFIG OPTIONS"); diff --git a/modules/openapi-generator-gradle-plugin/README.adoc b/modules/openapi-generator-gradle-plugin/README.adoc index 160f4e57217dea5cc4d1cd39a87249e816340e85..bef9375351af9243981662238e2bdcbb4be1d53a 100644 --- a/modules/openapi-generator-gradle-plugin/README.adoc +++ b/modules/openapi-generator-gradle-plugin/README.adoc @@ -337,7 +337,7 @@ apply plugin: 'org.openapi.generator' |configOptions |Map(String,String) |None -|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) +|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). Note that any config options from a generator specific document may go here, and some generators may duplicate other options which are siblings to `configOptions`. |logToStderr |Boolean diff --git a/website/sidebars.js b/website/sidebars.js index 0a30da35a265f49145f9019c24ccf5e10bcf2b99..004387f21a2e8e6ebecce2fa17a35725ee5d1e3e 100755 --- a/website/sidebars.js +++ b/website/sidebars.js @@ -7,6 +7,7 @@ module.exports = { 'online', 'usage', 'globals', + 'configuration', 'file-post-processing' ], 'Extending': [