diff --git a/docs/configuration.md b/docs/configuration.md new file mode 100644 index 00000000000..1fa33922ce8 --- /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 `` and `` 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 `. 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** + +``` + + mysql-schema + generate-sources + + generate + + + spec.yaml + mysql-schema + + snake_case + + ${project.build.directory}/generated-sources/mysql + + +``` + +**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 9806f13d378..731aefee358 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 7a58eb1232d..7fe92e9ee48 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 900c6e1c4b3..6173d90e89d 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 984a942c6ce..0c33f09143e 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 31e666618c5..00f25f255ca 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 e9ff8d86ca6..bf6eab0b9eb 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 c5d4207c765..b28410855f8 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 585482608fe..d3582171591 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 3eb089386fa..6b089ce4260 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 0fdf91d1843..6dac18478fd 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 69acb89fee6..8b8338ecf49 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 88bcbe76f8e..0e4046ec566 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 4792d7a678a..2258aa2535e 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 50a290931bf..3f4632d0b47 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 d30b18b9884..4683a9be64b 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 cb70cea8225..9dfbb390514 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 e39c66ddb5a..ce44d3384bf 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 1b8100b882d..8ff6e11f990 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 9e6175a7bfd..3b5cee05e30 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 3d2b030d568..537db8e94c9 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 28218b990e0..fe7594a243b 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 3b667b8cd85..663bc7c5d0f 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 403e7fcae96..72a31cd525f 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 653d6ef473d..39e509e6b9f 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 d4430311aed..eb92db2c764 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 ea44c79ed38..4995b0a3310 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 901e797c520..b146e47b200 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 dae9373b25f..668164352bd 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 0e077ce9d65..f475840400d 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 2208ade1063..73b67667616 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 ffbd3301a98..225eaebe8bb 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 0cb48d844cf..05e90e71235 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 92aa5b3c168..e9c35f8fe85 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 11555313299..5330b928fa4 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 12e76c3e4f4..78a80118ea3 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 1554abf9f2a..f374168aa71 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 7e8619c889a..4faa3a8b636 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 4e26377ec19..85e24728f1e 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 f19d4b51996..e0abd3de52c 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 ea42c12988c..21883f9995d 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.|
**false**
The 'additionalProperties' implementation is compliant with the OAS and JSON schema specifications.
**true**
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.
|true| diff --git a/docs/generators/graphql-nodejs-express-server.md b/docs/generators/graphql-nodejs-express-server.md index 050142f89b3..20eda0bb6c3 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 0ae8e628fe8..b64d9576599 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 4dd1f414a89..8f48ab64c0b 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 d0e161bab26..09d152af0d8 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 9d0a3e70085..17b7b891abe 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 e364221ebbd..16774bf3932 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 978015e37ee..a37b319931d 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 7982437c1a7..cd6cb8880f3 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 40c9fb24935..2728cc4afad 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 ac610a825c6..fcc8585cce8 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 0650ed1b889..98cccb0cbdf 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 a9dcb53d636..325d0eb23e2 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 0d3e7499362..ad80dc990b3 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 7186a6cae63..f65cd6ccded 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 e951671ac68..5d258a98568 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 d4eb3c5ef19..bfeab1a9cdf 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 73d032be478..57c05bea77c 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 7615018ca0a..1e8585d234e 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 2e5ff08df5b..6c319af5fec 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 02861221b0c..2bf760d692f 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 72167b95199..00a7802804c 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 50851c3de01..4fc2d41055a 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 509dfbc61c5..ee2a3f214c8 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 32b151ade98..056afbe7663 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 db791652f15..24b64e1da9a 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 44c957929a9..16423eae7d6 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 a88bc00bbda..1b125b6f118 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 0a9c0d02d07..f5bc72e14b2 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 08505b7477e..12a596f78ac 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 f1f40577541..f474fbc7415 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 fad263186ab..4a0353d7899 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 cd1578baf44..cb0dbfe41cc 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 c53f7f7a59d..e37648a9d6a 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 6f372cbd04b..6f9f4a80eaf 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 143e109fd2a..d9eea806f93 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 7f12cc69690..8526ade4f06 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 8e513792751..eefaccac90a 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 362f60b40c0..2c35e590580 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 de53cd50ea6..ad51253f978 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 e2b2b1d518d..020c9404f47 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 5d82b99ccbb..7e895bb5d5c 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 d2815cff29c..03dc722a2f8 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 a2e8ca6836c..910abd78432 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 61f4f5138b2..25abdc13676 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 29739bfab45..4c6900199c8 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 4019782c1c7..0651855af55 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 d40c6b0308d..bc1d05dfe70 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 15153acfd09..93484686dc2 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 451ba2d59de..be179ff4bd3 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 a0fe342b3e2..3d1f34d54ed 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 7923a3c8952..b3191b93478 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 df313bd1062..1228a6860a9 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 03d638a3c8f..8d3d2820d7c 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 a5836a73663..104a47fe59c 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 e9de567fe3c..a269b150f0d 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 737e67f1aac..f3607495f8e 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 c063b96dec8..309ab81e9a4 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 6326bd49fb7..e665eb34ba5 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 a56aa1530ed..f00e529e1f8 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 79bbb0bea06..69613835612 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|
**default**
Use stop() for raising exceptions.
**rlang**
Use rlang package for exceptions.
|default| diff --git a/docs/generators/ruby-on-rails.md b/docs/generators/ruby-on-rails.md index ec34e9afdde..b90e8757a90 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 ea23b05175f..2d8b774dbea 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 36fbb360363..141d0f8118e 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 a0e108d3069..d24af6089b7 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 a98dbf462e1..03febbd5fb0 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 8d4427703ec..1e6f77a1dd6 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 d3be948ccd9..756be4dfc34 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 c731772cb54..fcaa5a62c26 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 7115fb84a8f..4cc96bc6c95 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 d7ee388c356..41b6bf8046c 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 96f452a6a08..dc3bc36f281 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 6783a03f403..ecd00b7651e 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 45b7e9a0875..8222df26d85 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 a7d3de36f75..2c8f7661579 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 6bcdd2126b9..73b4debc3b2 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 fc3ea56b7da..19b3f1e75ef 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 956d1beac34..a7faa8a27d6 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 8a2bf935fab..fd5ac69ff1c 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 64014fe7238..d859d3f759b 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 ad2c7aea207..5a859f986df 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 571c512b367..51da119e7e3 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 320764ccf6d..3b53d601ac0 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 a39310fbc28..6aa54572fa1 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 68f0508b733..3496f86d0dc 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 db0393ca006..4e337ccd14b 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 64f6010a3e4..c37e351c4fd 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 01f970e7311..558a684bf06 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 ce2adb8289f..7bd3cec0bb4 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 db106fdb773..fa4cf6aab66 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 7ad0e1ba709..57eac715712 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 160f4e57217..bef9375351a 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 0a30da35a26..004387f21a2 100755 --- a/website/sidebars.js +++ b/website/sidebars.js @@ -7,6 +7,7 @@ module.exports = { 'online', 'usage', 'globals', + 'configuration', 'file-post-processing' ], 'Extending': [