From d813d04f4601b5bf96534f99b5233e93fb1ad79c Mon Sep 17 00:00:00 2001 From: Justin Black Date: Sun, 9 Jan 2022 14:10:47 -0800 Subject: [PATCH] Improves generator docs, adds metadata section (#11262) * Refactors generator md creation, adds generateMdMetadata * Removes extra space * Adds docs updates * Fixes table definition for metadata * Docs update * Docs update * Updates title, removes sidebar_label because it was not doing anything on pages like https://openapi-generator.tech/docs/generators/android * Docs updated --- docs/generators/ada-server.md | 12 +- docs/generators/ada.md | 12 +- docs/generators/android.md | 12 +- docs/generators/apache2.md | 12 +- docs/generators/apex.md | 12 +- docs/generators/asciidoc.md | 12 +- docs/generators/aspnetcore.md | 12 +- docs/generators/avro-schema.md | 12 +- docs/generators/bash.md | 12 +- docs/generators/c.md | 12 +- docs/generators/clojure.md | 12 +- docs/generators/cpp-pistache-server.md | 12 +- docs/generators/cpp-qt-client.md | 12 +- docs/generators/cpp-qt-qhttpengine-server.md | 12 +- docs/generators/cpp-restbed-server.md | 12 +- docs/generators/cpp-restsdk.md | 12 +- docs/generators/cpp-tiny.md | 12 +- docs/generators/cpp-tizen.md | 12 +- docs/generators/cpp-ue4.md | 12 +- docs/generators/crystal.md | 12 +- docs/generators/csharp-dotnet2.md | 12 +- docs/generators/csharp-nancyfx.md | 12 +- docs/generators/csharp-netcore-functions.md | 12 +- docs/generators/csharp-netcore.md | 12 +- docs/generators/csharp.md | 12 +- docs/generators/cwiki.md | 12 +- docs/generators/dart-dio-next.md | 12 +- docs/generators/dart-dio.md | 12 +- docs/generators/dart-jaguar.md | 12 +- docs/generators/dart.md | 12 +- docs/generators/dynamic-html.md | 12 +- docs/generators/eiffel.md | 12 +- docs/generators/elixir.md | 12 +- docs/generators/elm.md | 12 +- docs/generators/erlang-client.md | 12 +- docs/generators/erlang-proper.md | 12 +- docs/generators/erlang-server.md | 12 +- docs/generators/flash-deprecated.md | 12 +- docs/generators/fsharp-functions.md | 12 +- docs/generators/fsharp-giraffe-server.md | 12 +- docs/generators/go-deprecated.md | 12 +- docs/generators/go-echo-server.md | 12 +- docs/generators/go-gin-server.md | 12 +- docs/generators/go-server.md | 12 +- docs/generators/go.md | 12 +- .../graphql-nodejs-express-server.md | 12 +- docs/generators/graphql-schema.md | 12 +- docs/generators/groovy.md | 12 +- docs/generators/haskell-http-client.md | 12 +- docs/generators/haskell-yesod.md | 12 +- docs/generators/haskell.md | 12 +- docs/generators/html.md | 12 +- docs/generators/html2.md | 12 +- docs/generators/java-inflector.md | 12 +- docs/generators/java-micronaut-client.md | 12 +- docs/generators/java-msf4j.md | 12 +- docs/generators/java-pkmst.md | 12 +- docs/generators/java-play-framework.md | 12 +- docs/generators/java-undertow-server.md | 12 +- docs/generators/java-vertx-web.md | 12 +- docs/generators/java-vertx.md | 12 +- docs/generators/java.md | 12 +- docs/generators/javascript-apollo.md | 12 +- docs/generators/javascript-closure-angular.md | 12 +- docs/generators/javascript-flowtyped.md | 12 +- docs/generators/javascript.md | 12 +- docs/generators/jaxrs-cxf-cdi.md | 12 +- docs/generators/jaxrs-cxf-client.md | 12 +- docs/generators/jaxrs-cxf-extended.md | 12 +- docs/generators/jaxrs-cxf.md | 12 +- docs/generators/jaxrs-jersey.md | 12 +- docs/generators/jaxrs-resteasy-eap.md | 12 +- docs/generators/jaxrs-resteasy.md | 12 +- docs/generators/jaxrs-spec.md | 12 +- docs/generators/jmeter.md | 12 +- docs/generators/k6.md | 12 +- docs/generators/kotlin-server-deprecated.md | 12 +- docs/generators/kotlin-server.md | 12 +- docs/generators/kotlin-spring.md | 12 +- docs/generators/kotlin-vertx.md | 12 +- docs/generators/kotlin.md | 12 +- docs/generators/ktorm-schema.md | 12 +- docs/generators/lua.md | 12 +- docs/generators/markdown.md | 12 +- docs/generators/mysql-schema.md | 12 +- docs/generators/nim.md | 12 +- docs/generators/nodejs-express-server.md | 12 +- docs/generators/objc.md | 12 +- docs/generators/ocaml.md | 12 +- docs/generators/openapi-yaml.md | 12 +- docs/generators/openapi.md | 12 +- docs/generators/perl.md | 12 +- docs/generators/php-dt.md | 12 +- docs/generators/php-laravel.md | 12 +- docs/generators/php-lumen.md | 12 +- docs/generators/php-mezzio-ph.md | 12 +- docs/generators/php-silex-deprecated.md | 12 +- docs/generators/php-slim-deprecated.md | 12 +- docs/generators/php-slim4.md | 12 +- docs/generators/php-symfony.md | 12 +- docs/generators/php.md | 12 +- docs/generators/plantuml.md | 12 +- docs/generators/powershell.md | 12 +- docs/generators/protobuf-schema.md | 12 +- docs/generators/python-aiohttp.md | 12 +- docs/generators/python-blueplanet.md | 12 +- docs/generators/python-experimental.md | 12 +- docs/generators/python-fastapi.md | 12 +- docs/generators/python-flask.md | 12 +- docs/generators/python-legacy.md | 12 +- docs/generators/python.md | 12 +- docs/generators/r.md | 12 +- docs/generators/ruby-on-rails.md | 12 +- docs/generators/ruby-sinatra.md | 12 +- docs/generators/ruby.md | 12 +- docs/generators/rust-server.md | 12 +- docs/generators/rust.md | 12 +- docs/generators/scala-akka-http-server.md | 12 +- docs/generators/scala-akka.md | 12 +- docs/generators/scala-finch.md | 12 +- docs/generators/scala-gatling.md | 12 +- .../generators/scala-httpclient-deprecated.md | 12 +- docs/generators/scala-lagom-server.md | 12 +- docs/generators/scala-play-server.md | 12 +- docs/generators/scala-sttp.md | 12 +- docs/generators/scalatra.md | 12 +- docs/generators/scalaz.md | 12 +- docs/generators/spring.md | 12 +- docs/generators/swift4-deprecated.md | 12 +- docs/generators/swift5.md | 12 +- docs/generators/typescript-angular.md | 12 +- .../typescript-angularjs-deprecated.md | 12 +- docs/generators/typescript-aurelia.md | 12 +- docs/generators/typescript-axios.md | 12 +- docs/generators/typescript-fetch.md | 12 +- docs/generators/typescript-inversify.md | 12 +- docs/generators/typescript-jquery.md | 12 +- docs/generators/typescript-nestjs.md | 12 +- docs/generators/typescript-node.md | 12 +- docs/generators/typescript-redux-query.md | 12 +- docs/generators/typescript-rxjs.md | 12 +- docs/generators/typescript.md | 12 +- docs/generators/wsdl-schema.md | 12 +- .../openapitools/codegen/cmd/ConfigHelp.java | 224 +++++++++++------- .../PythonExperimentalClientCodegen.java | 2 +- 145 files changed, 1567 insertions(+), 375 deletions(-) diff --git a/docs/generators/ada-server.md b/docs/generators/ada-server.md index f88751432cb..ae41a6fb725 100644 --- a/docs/generators/ada-server.md +++ b/docs/generators/ada-server.md @@ -1,8 +1,16 @@ --- -title: Config Options for ada-server -sidebar_label: ada-server +title: Documentation for the ada-server Generator --- +## METADATA + +| Property | Value | Notes | +| -------- | ----- | ----- | +| generator name | ada-server | pass this to the generate command after -g | +| generator type | SERVER | | +| helpTxt | Generates an Ada server implementation (beta). | | + +## CONFIG OPTIONS These options may be applied 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/ada.md b/docs/generators/ada.md index 3c08371fe24..ba6a764ac31 100644 --- a/docs/generators/ada.md +++ b/docs/generators/ada.md @@ -1,8 +1,16 @@ --- -title: Config Options for ada -sidebar_label: ada +title: Documentation for the ada Generator --- +## METADATA + +| Property | Value | Notes | +| -------- | ----- | ----- | +| generator name | ada | pass this to the generate command after -g | +| generator type | CLIENT | | +| helpTxt | Generates an Ada client implementation (beta). | | + +## CONFIG OPTIONS These options may be applied 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/android.md b/docs/generators/android.md index 12e99f75cf3..53bde3fa486 100644 --- a/docs/generators/android.md +++ b/docs/generators/android.md @@ -1,8 +1,16 @@ --- -title: Config Options for android -sidebar_label: android +title: Documentation for the android Generator --- +## METADATA + +| Property | Value | Notes | +| -------- | ----- | ----- | +| generator name | android | pass this to the generate command after -g | +| generator type | CLIENT | | +| helpTxt | Generates an Android client library. | | + +## CONFIG OPTIONS These options may be applied 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/apache2.md b/docs/generators/apache2.md index 0db25b032cd..c31d64f4986 100644 --- a/docs/generators/apache2.md +++ b/docs/generators/apache2.md @@ -1,8 +1,16 @@ --- -title: Config Options for apache2 -sidebar_label: apache2 +title: Documentation for the apache2 Generator --- +## METADATA + +| Property | Value | Notes | +| -------- | ----- | ----- | +| generator name | apache2 | pass this to the generate command after -g | +| generator type | CONFIG | | +| helpTxt | Generates an Apache2 Config file with the permissions | | + +## CONFIG OPTIONS These options may be applied 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/apex.md b/docs/generators/apex.md index 89dfd44654d..5610d51d22e 100644 --- a/docs/generators/apex.md +++ b/docs/generators/apex.md @@ -1,8 +1,16 @@ --- -title: Config Options for apex -sidebar_label: apex +title: Documentation for the apex Generator --- +## METADATA + +| Property | Value | Notes | +| -------- | ----- | ----- | +| generator name | apex | pass this to the generate command after -g | +| generator type | CLIENT | | +| helpTxt | Generates an Apex API client library. | | + +## CONFIG OPTIONS These options may be applied 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/asciidoc.md b/docs/generators/asciidoc.md index 80f949644c8..a3b4795a2c8 100644 --- a/docs/generators/asciidoc.md +++ b/docs/generators/asciidoc.md @@ -1,8 +1,16 @@ --- -title: Config Options for asciidoc -sidebar_label: asciidoc +title: Documentation for the asciidoc Generator --- +## METADATA + +| Property | Value | Notes | +| -------- | ----- | ----- | +| generator name | asciidoc | pass this to the generate command after -g | +| generator type | DOCUMENTATION | | +| helpTxt | Generates asciidoc markup based documentation. | | + +## CONFIG OPTIONS These options may be applied 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/aspnetcore.md b/docs/generators/aspnetcore.md index 6e07567bcc1..cebbaf9a870 100644 --- a/docs/generators/aspnetcore.md +++ b/docs/generators/aspnetcore.md @@ -1,8 +1,16 @@ --- -title: Config Options for aspnetcore -sidebar_label: aspnetcore +title: Documentation for the aspnetcore Generator --- +## METADATA + +| Property | Value | Notes | +| -------- | ----- | ----- | +| generator name | aspnetcore | pass this to the generate command after -g | +| generator type | SERVER | | +| helpTxt | Generates an ASP.NET Core Web API server. | | + +## CONFIG OPTIONS These options may be applied 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/avro-schema.md b/docs/generators/avro-schema.md index cbb7dd6e3f0..506aca5d85b 100644 --- a/docs/generators/avro-schema.md +++ b/docs/generators/avro-schema.md @@ -1,8 +1,16 @@ --- -title: Config Options for avro-schema -sidebar_label: avro-schema +title: Documentation for the avro-schema Generator --- +## METADATA + +| Property | Value | Notes | +| -------- | ----- | ----- | +| generator name | avro-schema | pass this to the generate command after -g | +| generator type | SCHEMA | | +| helpTxt | Generates a Avro model (beta). | | + +## CONFIG OPTIONS These options may be applied 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/bash.md b/docs/generators/bash.md index 590f535c54f..524c9534fa5 100644 --- a/docs/generators/bash.md +++ b/docs/generators/bash.md @@ -1,8 +1,16 @@ --- -title: Config Options for bash -sidebar_label: bash +title: Documentation for the bash Generator --- +## METADATA + +| Property | Value | Notes | +| -------- | ----- | ----- | +| generator name | bash | pass this to the generate command after -g | +| generator type | CLIENT | | +| helpTxt | Generates a Bash client script based on cURL. | | + +## CONFIG OPTIONS These options may be applied 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/c.md b/docs/generators/c.md index c6e5c35372f..3eb885a9a11 100644 --- a/docs/generators/c.md +++ b/docs/generators/c.md @@ -1,8 +1,16 @@ --- -title: Config Options for c -sidebar_label: c +title: Documentation for the c Generator --- +## METADATA + +| Property | Value | Notes | +| -------- | ----- | ----- | +| generator name | c | pass this to the generate command after -g | +| generator type | CLIENT | | +| helpTxt | Generates a C (libcurl) client library (beta). | | + +## CONFIG OPTIONS These options may be applied 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/clojure.md b/docs/generators/clojure.md index cf7b0c3bc03..2f5fadc54c9 100644 --- a/docs/generators/clojure.md +++ b/docs/generators/clojure.md @@ -1,8 +1,16 @@ --- -title: Config Options for clojure -sidebar_label: clojure +title: Documentation for the clojure Generator --- +## METADATA + +| Property | Value | Notes | +| -------- | ----- | ----- | +| generator name | clojure | pass this to the generate command after -g | +| generator type | CLIENT | | +| helpTxt | Generates a Clojure client library. | | + +## CONFIG OPTIONS These options may be applied 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/cpp-pistache-server.md b/docs/generators/cpp-pistache-server.md index 0e4046ec566..d58a5f17572 100644 --- a/docs/generators/cpp-pistache-server.md +++ b/docs/generators/cpp-pistache-server.md @@ -1,8 +1,16 @@ --- -title: Config Options for cpp-pistache-server -sidebar_label: cpp-pistache-server +title: Documentation for the cpp-pistache-server Generator --- +## METADATA + +| Property | Value | Notes | +| -------- | ----- | ----- | +| generator name | cpp-pistache-server | pass this to the generate command after -g | +| generator type | SERVER | | +| helpTxt | Generates a C++ API server (based on Pistache) | | + +## CONFIG OPTIONS These options may be applied 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/cpp-qt-client.md b/docs/generators/cpp-qt-client.md index 4bb53da53f3..8ad0c33d85c 100644 --- a/docs/generators/cpp-qt-client.md +++ b/docs/generators/cpp-qt-client.md @@ -1,8 +1,16 @@ --- -title: Config Options for cpp-qt-client -sidebar_label: cpp-qt-client +title: Documentation for the cpp-qt-client Generator --- +## METADATA + +| Property | Value | Notes | +| -------- | ----- | ----- | +| generator name | cpp-qt-client | pass this to the generate command after -g | +| generator type | CLIENT | | +| helpTxt | Generates a Qt C++ client library. | | + +## CONFIG OPTIONS These options may be applied 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/cpp-qt-qhttpengine-server.md b/docs/generators/cpp-qt-qhttpengine-server.md index 6126b80c254..99dbeca8759 100644 --- a/docs/generators/cpp-qt-qhttpengine-server.md +++ b/docs/generators/cpp-qt-qhttpengine-server.md @@ -1,8 +1,16 @@ --- -title: Config Options for cpp-qt-qhttpengine-server -sidebar_label: cpp-qt-qhttpengine-server +title: Documentation for the cpp-qt-qhttpengine-server Generator --- +## METADATA + +| Property | Value | Notes | +| -------- | ----- | ----- | +| generator name | cpp-qt-qhttpengine-server | pass this to the generate command after -g | +| generator type | SERVER | | +| helpTxt | Generates a Qt C++ Server using the QHTTPEngine HTTP Library. | | + +## CONFIG OPTIONS These options may be applied 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/cpp-restbed-server.md b/docs/generators/cpp-restbed-server.md index 4683a9be64b..193e11cc92d 100644 --- a/docs/generators/cpp-restbed-server.md +++ b/docs/generators/cpp-restbed-server.md @@ -1,8 +1,16 @@ --- -title: Config Options for cpp-restbed-server -sidebar_label: cpp-restbed-server +title: Documentation for the cpp-restbed-server Generator --- +## METADATA + +| Property | Value | Notes | +| -------- | ----- | ----- | +| generator name | cpp-restbed-server | pass this to the generate command after -g | +| generator type | SERVER | | +| helpTxt | Generates a C++ API Server with Restbed (https://github.com/Corvusoft/restbed). | | + +## CONFIG OPTIONS These options may be applied 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/cpp-restsdk.md b/docs/generators/cpp-restsdk.md index 4fc97b939ae..480178fdf62 100644 --- a/docs/generators/cpp-restsdk.md +++ b/docs/generators/cpp-restsdk.md @@ -1,8 +1,16 @@ --- -title: Config Options for cpp-restsdk -sidebar_label: cpp-restsdk +title: Documentation for the cpp-restsdk Generator --- +## METADATA + +| Property | Value | Notes | +| -------- | ----- | ----- | +| generator name | cpp-restsdk | pass this to the generate command after -g | +| generator type | CLIENT | | +| helpTxt | Generates a C++ API client with C++ REST SDK (https://github.com/Microsoft/cpprestsdk). | | + +## CONFIG OPTIONS These options may be applied 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/cpp-tiny.md b/docs/generators/cpp-tiny.md index 4da8351e58a..006561e38f7 100644 --- a/docs/generators/cpp-tiny.md +++ b/docs/generators/cpp-tiny.md @@ -1,8 +1,16 @@ --- -title: Config Options for cpp-tiny -sidebar_label: cpp-tiny +title: Documentation for the cpp-tiny Generator --- +## METADATA + +| Property | Value | Notes | +| -------- | ----- | ----- | +| generator name | cpp-tiny | pass this to the generate command after -g | +| generator type | CLIENT | | +| helpTxt | Generates a C++ Arduino REST API client. | | + +## CONFIG OPTIONS These options may be applied 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/cpp-tizen.md b/docs/generators/cpp-tizen.md index 7f5b106c048..4f40b91b7d3 100644 --- a/docs/generators/cpp-tizen.md +++ b/docs/generators/cpp-tizen.md @@ -1,8 +1,16 @@ --- -title: Config Options for cpp-tizen -sidebar_label: cpp-tizen +title: Documentation for the cpp-tizen Generator --- +## METADATA + +| Property | Value | Notes | +| -------- | ----- | ----- | +| generator name | cpp-tizen | pass this to the generate command after -g | +| generator type | CLIENT | | +| helpTxt | Generates a Samsung Tizen C++ client library. | | + +## CONFIG OPTIONS These options may be applied 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/cpp-ue4.md b/docs/generators/cpp-ue4.md index be06301a99d..a2961af1612 100644 --- a/docs/generators/cpp-ue4.md +++ b/docs/generators/cpp-ue4.md @@ -1,8 +1,16 @@ --- -title: Config Options for cpp-ue4 -sidebar_label: cpp-ue4 +title: Documentation for the cpp-ue4 Generator --- +## METADATA + +| Property | Value | Notes | +| -------- | ----- | ----- | +| generator name | cpp-ue4 | pass this to the generate command after -g | +| generator type | CLIENT | | +| helpTxt | Generates a Unreal Engine 4 C++ Module (beta). | | + +## CONFIG OPTIONS These options may be applied 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/crystal.md b/docs/generators/crystal.md index b79135246bb..eaacb566be9 100644 --- a/docs/generators/crystal.md +++ b/docs/generators/crystal.md @@ -1,8 +1,16 @@ --- -title: Config Options for crystal -sidebar_label: crystal +title: Documentation for the crystal Generator --- +## METADATA + +| Property | Value | Notes | +| -------- | ----- | ----- | +| generator name | crystal | pass this to the generate command after -g | +| generator type | CLIENT | | +| helpTxt | Generates a Crystal client library (beta). | | + +## CONFIG OPTIONS These options may be applied 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/csharp-dotnet2.md b/docs/generators/csharp-dotnet2.md index fa97c717000..b1d47b73ac6 100644 --- a/docs/generators/csharp-dotnet2.md +++ b/docs/generators/csharp-dotnet2.md @@ -1,8 +1,16 @@ --- -title: Config Options for csharp-dotnet2 -sidebar_label: csharp-dotnet2 +title: Documentation for the csharp-dotnet2 Generator --- +## METADATA + +| Property | Value | Notes | +| -------- | ----- | ----- | +| generator name | csharp-dotnet2 | pass this to the generate command after -g | +| generator type | CLIENT | | +| helpTxt | Generates a C# .Net 2.0 client library (beta). | | + +## CONFIG OPTIONS These options may be applied 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/csharp-nancyfx.md b/docs/generators/csharp-nancyfx.md index f08b5157930..b8b5928ed63 100644 --- a/docs/generators/csharp-nancyfx.md +++ b/docs/generators/csharp-nancyfx.md @@ -1,8 +1,16 @@ --- -title: Config Options for csharp-nancyfx -sidebar_label: csharp-nancyfx +title: Documentation for the csharp-nancyfx Generator --- +## METADATA + +| Property | Value | Notes | +| -------- | ----- | ----- | +| generator name | csharp-nancyfx | pass this to the generate command after -g | +| generator type | SERVER | | +| helpTxt | Generates a C# NancyFX Web API server. | | + +## CONFIG OPTIONS These options may be applied 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/csharp-netcore-functions.md b/docs/generators/csharp-netcore-functions.md index 50ec49b34a1..6d856577317 100644 --- a/docs/generators/csharp-netcore-functions.md +++ b/docs/generators/csharp-netcore-functions.md @@ -1,8 +1,16 @@ --- -title: Config Options for csharp-netcore-functions -sidebar_label: csharp-netcore-functions +title: Documentation for the csharp-netcore-functions Generator --- +## METADATA + +| Property | Value | Notes | +| -------- | ----- | ----- | +| generator name | csharp-netcore-functions | pass this to the generate command after -g | +| generator type | SERVER | | +| helpTxt | Generates a csharp server. | | + +## CONFIG OPTIONS These options may be applied 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/csharp-netcore.md b/docs/generators/csharp-netcore.md index bb138ef414d..33b124200fb 100644 --- a/docs/generators/csharp-netcore.md +++ b/docs/generators/csharp-netcore.md @@ -1,8 +1,16 @@ --- -title: Config Options for csharp-netcore -sidebar_label: csharp-netcore +title: Documentation for the csharp-netcore Generator --- +## METADATA + +| Property | Value | Notes | +| -------- | ----- | ----- | +| generator name | csharp-netcore | pass this to the generate command after -g | +| generator type | CLIENT | | +| helpTxt | Generates a C# client library (.NET Standard, .NET Core). | | + +## CONFIG OPTIONS These options may be applied 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/csharp.md b/docs/generators/csharp.md index b572a6c3710..c925eecc8e7 100644 --- a/docs/generators/csharp.md +++ b/docs/generators/csharp.md @@ -1,8 +1,16 @@ --- -title: Config Options for csharp -sidebar_label: csharp +title: Documentation for the csharp Generator --- +## METADATA + +| Property | Value | Notes | +| -------- | ----- | ----- | +| generator name | csharp | pass this to the generate command after -g | +| generator type | CLIENT | | +| helpTxt | Generates a CSharp client library. | | + +## CONFIG OPTIONS These options may be applied 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/cwiki.md b/docs/generators/cwiki.md index d10f1d303ef..13a6eb489e3 100644 --- a/docs/generators/cwiki.md +++ b/docs/generators/cwiki.md @@ -1,8 +1,16 @@ --- -title: Config Options for cwiki -sidebar_label: cwiki +title: Documentation for the cwiki Generator --- +## METADATA + +| Property | Value | Notes | +| -------- | ----- | ----- | +| generator name | cwiki | pass this to the generate command after -g | +| generator type | DOCUMENTATION | | +| helpTxt | Generates confluence wiki markup. | | + +## CONFIG OPTIONS These options may be applied 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/dart-dio-next.md b/docs/generators/dart-dio-next.md index 869645f7da8..07b20e71d1a 100644 --- a/docs/generators/dart-dio-next.md +++ b/docs/generators/dart-dio-next.md @@ -1,8 +1,16 @@ --- -title: Config Options for dart-dio-next -sidebar_label: dart-dio-next +title: Documentation for the dart-dio-next Generator --- +## METADATA + +| Property | Value | Notes | +| -------- | ----- | ----- | +| generator name | dart-dio-next | pass this to the generate command after -g | +| generator type | CLIENT | | +| helpTxt | Generates a Dart Dio client library with null-safety. | | + +## CONFIG OPTIONS These options may be applied 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/dart-dio.md b/docs/generators/dart-dio.md index e3b6ac95639..77aeaab2538 100644 --- a/docs/generators/dart-dio.md +++ b/docs/generators/dart-dio.md @@ -1,8 +1,16 @@ --- -title: Config Options for dart-dio -sidebar_label: dart-dio +title: Documentation for the dart-dio Generator --- +## METADATA + +| Property | Value | Notes | +| -------- | ----- | ----- | +| generator name | dart-dio | pass this to the generate command after -g | +| generator type | CLIENT | | +| helpTxt | Generates a Dart Dio client library. | | + +## CONFIG OPTIONS These options may be applied 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/dart-jaguar.md b/docs/generators/dart-jaguar.md index 769fa166dab..1cbdd8bad48 100644 --- a/docs/generators/dart-jaguar.md +++ b/docs/generators/dart-jaguar.md @@ -1,8 +1,16 @@ --- -title: Config Options for dart-jaguar -sidebar_label: dart-jaguar +title: Documentation for the dart-jaguar Generator --- +## METADATA + +| Property | Value | Notes | +| -------- | ----- | ----- | +| generator name | dart-jaguar | pass this to the generate command after -g | +| generator type | CLIENT | | +| helpTxt | Generates a Dart Jaguar client library. | | + +## CONFIG OPTIONS These options may be applied 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/dart.md b/docs/generators/dart.md index 73f113808b4..7793319b30f 100644 --- a/docs/generators/dart.md +++ b/docs/generators/dart.md @@ -1,8 +1,16 @@ --- -title: Config Options for dart -sidebar_label: dart +title: Documentation for the dart Generator --- +## METADATA + +| Property | Value | Notes | +| -------- | ----- | ----- | +| generator name | dart | pass this to the generate command after -g | +| generator type | CLIENT | | +| helpTxt | Generates a Dart 2.x client library. | | + +## CONFIG OPTIONS These options may be applied 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/dynamic-html.md b/docs/generators/dynamic-html.md index 771cecc8b15..ff0c25132f5 100644 --- a/docs/generators/dynamic-html.md +++ b/docs/generators/dynamic-html.md @@ -1,8 +1,16 @@ --- -title: Config Options for dynamic-html -sidebar_label: dynamic-html +title: Documentation for the dynamic-html Generator --- +## METADATA + +| Property | Value | Notes | +| -------- | ----- | ----- | +| generator name | dynamic-html | pass this to the generate command after -g | +| generator type | DOCUMENTATION | | +| helpTxt | Generates a dynamic HTML site. | | + +## CONFIG OPTIONS These options may be applied 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/eiffel.md b/docs/generators/eiffel.md index b2f38750eba..151654c6f14 100644 --- a/docs/generators/eiffel.md +++ b/docs/generators/eiffel.md @@ -1,8 +1,16 @@ --- -title: Config Options for eiffel -sidebar_label: eiffel +title: Documentation for the eiffel Generator --- +## METADATA + +| Property | Value | Notes | +| -------- | ----- | ----- | +| generator name | eiffel | pass this to the generate command after -g | +| generator type | CLIENT | | +| helpTxt | Generates a Eiffel client library (beta). | | + +## CONFIG OPTIONS These options may be applied 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/elixir.md b/docs/generators/elixir.md index 543f116ddb2..2a6d9d93e4c 100644 --- a/docs/generators/elixir.md +++ b/docs/generators/elixir.md @@ -1,8 +1,16 @@ --- -title: Config Options for elixir -sidebar_label: elixir +title: Documentation for the elixir Generator --- +## METADATA + +| Property | Value | Notes | +| -------- | ----- | ----- | +| generator name | elixir | pass this to the generate command after -g | +| generator type | CLIENT | | +| helpTxt | Generates an elixir client library (alpha). | | + +## CONFIG OPTIONS These options may be applied 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/elm.md b/docs/generators/elm.md index 73b67667616..79ff7df2e32 100644 --- a/docs/generators/elm.md +++ b/docs/generators/elm.md @@ -1,8 +1,16 @@ --- -title: Config Options for elm -sidebar_label: elm +title: Documentation for the elm Generator --- +## METADATA + +| Property | Value | Notes | +| -------- | ----- | ----- | +| generator name | elm | pass this to the generate command after -g | +| generator type | CLIENT | | +| helpTxt | Generates an Elm client library. | | + +## CONFIG OPTIONS These options may be applied 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 ebbd5e53ec6..3436fc2faad 100644 --- a/docs/generators/erlang-client.md +++ b/docs/generators/erlang-client.md @@ -1,8 +1,16 @@ --- -title: Config Options for erlang-client -sidebar_label: erlang-client +title: Documentation for the erlang-client Generator --- +## METADATA + +| Property | Value | Notes | +| -------- | ----- | ----- | +| generator name | erlang-client | pass this to the generate command after -g | +| generator type | CLIENT | | +| helpTxt | Generates an Erlang client library (beta). | | + +## CONFIG OPTIONS These options may be applied 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-proper.md b/docs/generators/erlang-proper.md index 4db9d763c9b..0a50ff9c285 100644 --- a/docs/generators/erlang-proper.md +++ b/docs/generators/erlang-proper.md @@ -1,8 +1,16 @@ --- -title: Config Options for erlang-proper -sidebar_label: erlang-proper +title: Documentation for the erlang-proper Generator --- +## METADATA + +| Property | Value | Notes | +| -------- | ----- | ----- | +| generator name | erlang-proper | pass this to the generate command after -g | +| generator type | CLIENT | | +| helpTxt | Generates an Erlang library with PropEr generators (beta). | | + +## CONFIG OPTIONS These options may be applied 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-server.md b/docs/generators/erlang-server.md index 385100fac8e..c6bbba108b4 100644 --- a/docs/generators/erlang-server.md +++ b/docs/generators/erlang-server.md @@ -1,8 +1,16 @@ --- -title: Config Options for erlang-server -sidebar_label: erlang-server +title: Documentation for the erlang-server Generator --- +## METADATA + +| Property | Value | Notes | +| -------- | ----- | ----- | +| generator name | erlang-server | pass this to the generate command after -g | +| generator type | SERVER | | +| helpTxt | Generates an Erlang server library (beta) using OpenAPI Generator (https://openapi-generator.tech). By default, it will also generate service classes, which can be disabled with the `-Dnoservice` environment variable. | | + +## CONFIG OPTIONS These options may be applied 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/flash-deprecated.md b/docs/generators/flash-deprecated.md index 5330b928fa4..b82898633d4 100644 --- a/docs/generators/flash-deprecated.md +++ b/docs/generators/flash-deprecated.md @@ -1,8 +1,16 @@ --- -title: Config Options for flash-deprecated -sidebar_label: flash-deprecated +title: Documentation for the flash-deprecated Generator --- +## METADATA + +| Property | Value | Notes | +| -------- | ----- | ----- | +| generator name | flash-deprecated | pass this to the generate command after -g | +| generator type | CLIENT | | +| helpTxt | Generates a Flash (ActionScript) client library (beta). IMPORTANT: this generator has been deprecated in v5.x | | + +## CONFIG OPTIONS These options may be applied 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/fsharp-functions.md b/docs/generators/fsharp-functions.md index de363c1ca6b..534dbbc445f 100644 --- a/docs/generators/fsharp-functions.md +++ b/docs/generators/fsharp-functions.md @@ -1,8 +1,16 @@ --- -title: Config Options for fsharp-functions -sidebar_label: fsharp-functions +title: Documentation for the fsharp-functions Generator --- +## METADATA + +| Property | Value | Notes | +| -------- | ----- | ----- | +| generator name | fsharp-functions | pass this to the generate command after -g | +| generator type | SERVER | | +| helpTxt | Generates a fsharp-functions server (beta). | | + +## CONFIG OPTIONS These options may be applied 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/fsharp-giraffe-server.md b/docs/generators/fsharp-giraffe-server.md index f374168aa71..fe1c0c180b4 100644 --- a/docs/generators/fsharp-giraffe-server.md +++ b/docs/generators/fsharp-giraffe-server.md @@ -1,8 +1,16 @@ --- -title: Config Options for fsharp-giraffe-server -sidebar_label: fsharp-giraffe-server +title: Documentation for the fsharp-giraffe-server Generator --- +## METADATA + +| Property | Value | Notes | +| -------- | ----- | ----- | +| generator name | fsharp-giraffe-server | pass this to the generate command after -g | +| generator type | SERVER | | +| helpTxt | Generates a F# Giraffe server (beta). | | + +## CONFIG OPTIONS These options may be applied 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/go-deprecated.md b/docs/generators/go-deprecated.md index 4faa3a8b636..cb19432610d 100644 --- a/docs/generators/go-deprecated.md +++ b/docs/generators/go-deprecated.md @@ -1,8 +1,16 @@ --- -title: Config Options for go-deprecated -sidebar_label: go-deprecated +title: Documentation for the go-deprecated Generator --- +## METADATA + +| Property | Value | Notes | +| -------- | ----- | ----- | +| generator name | go-deprecated | pass this to the generate command after -g | +| generator type | CLIENT | | +| helpTxt | Generates a Go client library (beta). NOTE: this generator has been deprecated. Please use `go` client generator instead. | | + +## CONFIG OPTIONS These options may be applied 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/go-echo-server.md b/docs/generators/go-echo-server.md index 53c726fb85e..9ad9e61c952 100644 --- a/docs/generators/go-echo-server.md +++ b/docs/generators/go-echo-server.md @@ -1,8 +1,16 @@ --- -title: Config Options for go-echo-server -sidebar_label: go-echo-server +title: Documentation for the go-echo-server Generator --- +## METADATA + +| Property | Value | Notes | +| -------- | ----- | ----- | +| generator name | go-echo-server | pass this to the generate command after -g | +| generator type | SERVER | | +| helpTxt | Generates a go-echo server. (Beta) | | + +## CONFIG OPTIONS These options may be applied 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/go-gin-server.md b/docs/generators/go-gin-server.md index 0c1d324191d..85c1e5efbc4 100644 --- a/docs/generators/go-gin-server.md +++ b/docs/generators/go-gin-server.md @@ -1,8 +1,16 @@ --- -title: Config Options for go-gin-server -sidebar_label: go-gin-server +title: Documentation for the go-gin-server Generator --- +## METADATA + +| Property | Value | Notes | +| -------- | ----- | ----- | +| generator name | go-gin-server | pass this to the generate command after -g | +| generator type | SERVER | | +| helpTxt | Generates a Go server library with the gin framework using OpenAPI-Generator.By default, it will also generate service classes. | | + +## CONFIG OPTIONS These options may be applied 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/go-server.md b/docs/generators/go-server.md index 440b3461b0f..f3f0a91da94 100644 --- a/docs/generators/go-server.md +++ b/docs/generators/go-server.md @@ -1,8 +1,16 @@ --- -title: Config Options for go-server -sidebar_label: go-server +title: Documentation for the go-server Generator --- +## METADATA + +| Property | Value | Notes | +| -------- | ----- | ----- | +| generator name | go-server | pass this to the generate command after -g | +| generator type | SERVER | | +| helpTxt | Generates a Go server library using OpenAPI-Generator. By default, it will also generate service classes -- which you can disable with the `-Dnoservice` environment variable. | | + +## CONFIG OPTIONS These options may be applied 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/go.md b/docs/generators/go.md index a2318c003f3..1bb81764435 100644 --- a/docs/generators/go.md +++ b/docs/generators/go.md @@ -1,8 +1,16 @@ --- -title: Config Options for go -sidebar_label: go +title: Documentation for the go Generator --- +## METADATA + +| Property | Value | Notes | +| -------- | ----- | ----- | +| generator name | go | pass this to the generate command after -g | +| generator type | CLIENT | | +| helpTxt | Generates a Go client library. | | + +## CONFIG OPTIONS These options may be applied 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/graphql-nodejs-express-server.md b/docs/generators/graphql-nodejs-express-server.md index ab641eba44b..a1f1248d285 100644 --- a/docs/generators/graphql-nodejs-express-server.md +++ b/docs/generators/graphql-nodejs-express-server.md @@ -1,8 +1,16 @@ --- -title: Config Options for graphql-nodejs-express-server -sidebar_label: graphql-nodejs-express-server +title: Documentation for the graphql-nodejs-express-server Generator --- +## METADATA + +| Property | Value | Notes | +| -------- | ----- | ----- | +| generator name | graphql-nodejs-express-server | pass this to the generate command after -g | +| generator type | SERVER | | +| helpTxt | Generates a GraphQL Node.js Express server (beta) including it's types, queries, mutations, (resolvers) | | + +## CONFIG OPTIONS These options may be applied 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/graphql-schema.md b/docs/generators/graphql-schema.md index 27f6b8ab9eb..ecdedafb3da 100644 --- a/docs/generators/graphql-schema.md +++ b/docs/generators/graphql-schema.md @@ -1,8 +1,16 @@ --- -title: Config Options for graphql-schema -sidebar_label: graphql-schema +title: Documentation for the graphql-schema Generator --- +## METADATA + +| Property | Value | Notes | +| -------- | ----- | ----- | +| generator name | graphql-schema | pass this to the generate command after -g | +| generator type | SCHEMA | | +| helpTxt | Generates GraphQL schema files (beta) | | + +## CONFIG OPTIONS These options may be applied 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/groovy.md b/docs/generators/groovy.md index 96df596870d..18c943c2860 100644 --- a/docs/generators/groovy.md +++ b/docs/generators/groovy.md @@ -1,8 +1,16 @@ --- -title: Config Options for groovy -sidebar_label: groovy +title: Documentation for the groovy Generator --- +## METADATA + +| Property | Value | Notes | +| -------- | ----- | ----- | +| generator name | groovy | pass this to the generate command after -g | +| generator type | CLIENT | | +| helpTxt | Generates a Groovy API client. | | + +## CONFIG OPTIONS These options may be applied 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/haskell-http-client.md b/docs/generators/haskell-http-client.md index f287982ab71..4515d4ad850 100644 --- a/docs/generators/haskell-http-client.md +++ b/docs/generators/haskell-http-client.md @@ -1,8 +1,16 @@ --- -title: Config Options for haskell-http-client -sidebar_label: haskell-http-client +title: Documentation for the haskell-http-client Generator --- +## METADATA + +| Property | Value | Notes | +| -------- | ----- | ----- | +| generator name | haskell-http-client | pass this to the generate command after -g | +| generator type | CLIENT | | +| helpTxt | Generates a Haskell http-client library. | | + +## CONFIG OPTIONS These options may be applied 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/haskell-yesod.md b/docs/generators/haskell-yesod.md index e4f8bd5a362..7993d7988b2 100644 --- a/docs/generators/haskell-yesod.md +++ b/docs/generators/haskell-yesod.md @@ -1,8 +1,16 @@ --- -title: Config Options for haskell-yesod -sidebar_label: haskell-yesod +title: Documentation for the haskell-yesod Generator --- +## METADATA + +| Property | Value | Notes | +| -------- | ----- | ----- | +| generator name | haskell-yesod | pass this to the generate command after -g | +| generator type | SERVER | | +| helpTxt | Generates a haskell-yesod server. | | + +## CONFIG OPTIONS These options may be applied 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/haskell.md b/docs/generators/haskell.md index 75dfe15ca50..28e69825493 100644 --- a/docs/generators/haskell.md +++ b/docs/generators/haskell.md @@ -1,8 +1,16 @@ --- -title: Config Options for haskell -sidebar_label: haskell +title: Documentation for the haskell Generator --- +## METADATA + +| Property | Value | Notes | +| -------- | ----- | ----- | +| generator name | haskell | pass this to the generate command after -g | +| generator type | SERVER | | +| helpTxt | Generates a Haskell server and client library. | | + +## CONFIG OPTIONS These options may be applied 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/html.md b/docs/generators/html.md index 0ece134692a..d597f69ce9e 100644 --- a/docs/generators/html.md +++ b/docs/generators/html.md @@ -1,8 +1,16 @@ --- -title: Config Options for html -sidebar_label: html +title: Documentation for the html Generator --- +## METADATA + +| Property | Value | Notes | +| -------- | ----- | ----- | +| generator name | html | pass this to the generate command after -g | +| generator type | DOCUMENTATION | | +| helpTxt | Generates a static HTML file. | | + +## CONFIG OPTIONS These options may be applied 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/html2.md b/docs/generators/html2.md index 40dc30a42e4..0e99b15a11e 100644 --- a/docs/generators/html2.md +++ b/docs/generators/html2.md @@ -1,8 +1,16 @@ --- -title: Config Options for html2 -sidebar_label: html2 +title: Documentation for the html2 Generator --- +## METADATA + +| Property | Value | Notes | +| -------- | ----- | ----- | +| generator name | html2 | pass this to the generate command after -g | +| generator type | DOCUMENTATION | | +| helpTxt | Generates a static HTML file. | | + +## CONFIG OPTIONS These options may be applied 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/java-inflector.md b/docs/generators/java-inflector.md index 309bc1a3dbb..48b4070382e 100644 --- a/docs/generators/java-inflector.md +++ b/docs/generators/java-inflector.md @@ -1,8 +1,16 @@ --- -title: Config Options for java-inflector -sidebar_label: java-inflector +title: Documentation for the java-inflector Generator --- +## METADATA + +| Property | Value | Notes | +| -------- | ----- | ----- | +| generator name | java-inflector | pass this to the generate command after -g | +| generator type | SERVER | | +| helpTxt | Generates a Java Inflector Server application. | | + +## CONFIG OPTIONS These options may be applied 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/java-micronaut-client.md b/docs/generators/java-micronaut-client.md index 98ce5396a97..898f2ee2f33 100644 --- a/docs/generators/java-micronaut-client.md +++ b/docs/generators/java-micronaut-client.md @@ -1,8 +1,16 @@ --- -title: Config Options for java-micronaut-client -sidebar_label: java-micronaut-client +title: Documentation for the java-micronaut-client Generator --- +## METADATA + +| Property | Value | Notes | +| -------- | ----- | ----- | +| generator name | java-micronaut-client | pass this to the generate command after -g | +| generator type | CLIENT | | +| helpTxt | Generates a Java Micronaut Client. | | + +## CONFIG OPTIONS These options may be applied 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/java-msf4j.md b/docs/generators/java-msf4j.md index d3a7aa4bd21..fd0b6ec7c27 100644 --- a/docs/generators/java-msf4j.md +++ b/docs/generators/java-msf4j.md @@ -1,8 +1,16 @@ --- -title: Config Options for java-msf4j -sidebar_label: java-msf4j +title: Documentation for the java-msf4j Generator --- +## METADATA + +| Property | Value | Notes | +| -------- | ----- | ----- | +| generator name | java-msf4j | pass this to the generate command after -g | +| generator type | SERVER | | +| helpTxt | Generates a Java Micro Service based on WSO2 Microservices Framework for Java (MSF4J) | | + +## CONFIG OPTIONS These options may be applied 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/java-pkmst.md b/docs/generators/java-pkmst.md index 1f7b1f7e262..9731d407c37 100644 --- a/docs/generators/java-pkmst.md +++ b/docs/generators/java-pkmst.md @@ -1,8 +1,16 @@ --- -title: Config Options for java-pkmst -sidebar_label: java-pkmst +title: Documentation for the java-pkmst Generator --- +## METADATA + +| Property | Value | Notes | +| -------- | ----- | ----- | +| generator name | java-pkmst | pass this to the generate command after -g | +| generator type | SERVER | | +| helpTxt | Generates a PKMST SpringBoot Server application using the SpringFox integration. Also enables EurekaServerClient / Zipkin / Spring-Boot admin | | + +## CONFIG OPTIONS These options may be applied 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/java-play-framework.md b/docs/generators/java-play-framework.md index 851e0c567a1..8137dc2f7a6 100644 --- a/docs/generators/java-play-framework.md +++ b/docs/generators/java-play-framework.md @@ -1,8 +1,16 @@ --- -title: Config Options for java-play-framework -sidebar_label: java-play-framework +title: Documentation for the java-play-framework Generator --- +## METADATA + +| Property | Value | Notes | +| -------- | ----- | ----- | +| generator name | java-play-framework | pass this to the generate command after -g | +| generator type | SERVER | | +| helpTxt | Generates a Java Play Framework Server application. | | + +## CONFIG OPTIONS These options may be applied 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/java-undertow-server.md b/docs/generators/java-undertow-server.md index f240e949090..340ae31025b 100644 --- a/docs/generators/java-undertow-server.md +++ b/docs/generators/java-undertow-server.md @@ -1,8 +1,16 @@ --- -title: Config Options for java-undertow-server -sidebar_label: java-undertow-server +title: Documentation for the java-undertow-server Generator --- +## METADATA + +| Property | Value | Notes | +| -------- | ----- | ----- | +| generator name | java-undertow-server | pass this to the generate command after -g | +| generator type | SERVER | | +| helpTxt | Generates a Java Undertow Server application (beta). | | + +## CONFIG OPTIONS These options may be applied 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/java-vertx-web.md b/docs/generators/java-vertx-web.md index 01135987760..5d4946c67d4 100644 --- a/docs/generators/java-vertx-web.md +++ b/docs/generators/java-vertx-web.md @@ -1,8 +1,16 @@ --- -title: Config Options for java-vertx-web -sidebar_label: java-vertx-web +title: Documentation for the java-vertx-web Generator --- +## METADATA + +| Property | Value | Notes | +| -------- | ----- | ----- | +| generator name | java-vertx-web | pass this to the generate command after -g | +| generator type | SERVER | | +| helpTxt | Generates a Java Vert.x-Web Server (beta). | | + +## CONFIG OPTIONS These options may be applied 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/java-vertx.md b/docs/generators/java-vertx.md index 435c1a12266..82660a9c9ea 100644 --- a/docs/generators/java-vertx.md +++ b/docs/generators/java-vertx.md @@ -1,8 +1,16 @@ --- -title: Config Options for java-vertx -sidebar_label: java-vertx +title: Documentation for the java-vertx Generator --- +## METADATA + +| Property | Value | Notes | +| -------- | ----- | ----- | +| generator name | java-vertx | pass this to the generate command after -g | +| generator type | SERVER | | +| helpTxt | Generates a java-Vert.X Server library. | | + +## CONFIG OPTIONS These options may be applied 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/java.md b/docs/generators/java.md index cdab88d701e..90aa5d73f66 100644 --- a/docs/generators/java.md +++ b/docs/generators/java.md @@ -1,8 +1,16 @@ --- -title: Config Options for java -sidebar_label: java +title: Documentation for the java Generator --- +## METADATA + +| Property | Value | Notes | +| -------- | ----- | ----- | +| generator name | java | pass this to the generate command after -g | +| generator type | CLIENT | | +| helpTxt | Generates a Java client library (HTTP lib: Jersey (1.x, 2.x), Retrofit (2.x), OpenFeign (10.x) and more. | | + +## CONFIG OPTIONS These options may be applied 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/javascript-apollo.md b/docs/generators/javascript-apollo.md index 260fc980945..3129864fb33 100644 --- a/docs/generators/javascript-apollo.md +++ b/docs/generators/javascript-apollo.md @@ -1,8 +1,16 @@ --- -title: Config Options for javascript-apollo -sidebar_label: javascript-apollo +title: Documentation for the javascript-apollo Generator --- +## METADATA + +| Property | Value | Notes | +| -------- | ----- | ----- | +| generator name | javascript-apollo | pass this to the generate command after -g | +| generator type | CLIENT | | +| helpTxt | Generates a JavaScript client library (beta) using Apollo RESTDatasource. | | + +## CONFIG OPTIONS These options may be applied 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/javascript-closure-angular.md b/docs/generators/javascript-closure-angular.md index 891b35cb933..b9da1dc8f55 100644 --- a/docs/generators/javascript-closure-angular.md +++ b/docs/generators/javascript-closure-angular.md @@ -1,8 +1,16 @@ --- -title: Config Options for javascript-closure-angular -sidebar_label: javascript-closure-angular +title: Documentation for the javascript-closure-angular Generator --- +## METADATA + +| Property | Value | Notes | +| -------- | ----- | ----- | +| generator name | javascript-closure-angular | pass this to the generate command after -g | +| generator type | CLIENT | | +| helpTxt | Generates a Javascript AngularJS client library (beta) annotated with Google Closure Compiler annotations(https://developers.google.com/closure/compiler/docs/js-for-compiler?hl=en) | | + +## CONFIG OPTIONS These options may be applied 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/javascript-flowtyped.md b/docs/generators/javascript-flowtyped.md index a6fcea0533c..76b81c5aa82 100644 --- a/docs/generators/javascript-flowtyped.md +++ b/docs/generators/javascript-flowtyped.md @@ -1,8 +1,16 @@ --- -title: Config Options for javascript-flowtyped -sidebar_label: javascript-flowtyped +title: Documentation for the javascript-flowtyped Generator --- +## METADATA + +| Property | Value | Notes | +| -------- | ----- | ----- | +| generator name | javascript-flowtyped | pass this to the generate command after -g | +| generator type | CLIENT | | +| helpTxt | Generates a Javascript client library (beta) using Flow types and Fetch API. | | + +## CONFIG OPTIONS These options may be applied 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/javascript.md b/docs/generators/javascript.md index 962b9ffc40e..2381c5108f3 100644 --- a/docs/generators/javascript.md +++ b/docs/generators/javascript.md @@ -1,8 +1,16 @@ --- -title: Config Options for javascript -sidebar_label: javascript +title: Documentation for the javascript Generator --- +## METADATA + +| Property | Value | Notes | +| -------- | ----- | ----- | +| generator name | javascript | pass this to the generate command after -g | +| generator type | CLIENT | | +| helpTxt | Generates a JavaScript client library. | | + +## CONFIG OPTIONS These options may be applied 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/jaxrs-cxf-cdi.md b/docs/generators/jaxrs-cxf-cdi.md index c46ec4c9631..1564b252520 100644 --- a/docs/generators/jaxrs-cxf-cdi.md +++ b/docs/generators/jaxrs-cxf-cdi.md @@ -1,8 +1,16 @@ --- -title: Config Options for jaxrs-cxf-cdi -sidebar_label: jaxrs-cxf-cdi +title: Documentation for the jaxrs-cxf-cdi Generator --- +## METADATA + +| Property | Value | Notes | +| -------- | ----- | ----- | +| generator name | jaxrs-cxf-cdi | pass this to the generate command after -g | +| generator type | SERVER | | +| helpTxt | Generates a Java JAXRS Server according to JAXRS 2.0 specification, assuming an Apache CXF runtime and a Java EE runtime with CDI enabled. | | + +## CONFIG OPTIONS These options may be applied 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/jaxrs-cxf-client.md b/docs/generators/jaxrs-cxf-client.md index ad1c6090036..b7fcd7f4942 100644 --- a/docs/generators/jaxrs-cxf-client.md +++ b/docs/generators/jaxrs-cxf-client.md @@ -1,8 +1,16 @@ --- -title: Config Options for jaxrs-cxf-client -sidebar_label: jaxrs-cxf-client +title: Documentation for the jaxrs-cxf-client Generator --- +## METADATA + +| Property | Value | Notes | +| -------- | ----- | ----- | +| generator name | jaxrs-cxf-client | pass this to the generate command after -g | +| generator type | CLIENT | | +| helpTxt | Generates a Java JAXRS Client based on Apache CXF framework. | | + +## CONFIG OPTIONS These options may be applied 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/jaxrs-cxf-extended.md b/docs/generators/jaxrs-cxf-extended.md index 0eef8cacd4e..c44b15f100b 100644 --- a/docs/generators/jaxrs-cxf-extended.md +++ b/docs/generators/jaxrs-cxf-extended.md @@ -1,8 +1,16 @@ --- -title: Config Options for jaxrs-cxf-extended -sidebar_label: jaxrs-cxf-extended +title: Documentation for the jaxrs-cxf-extended Generator --- +## METADATA + +| Property | Value | Notes | +| -------- | ----- | ----- | +| generator name | jaxrs-cxf-extended | pass this to the generate command after -g | +| generator type | SERVER | | +| helpTxt | Extends jaxrs-cxf with options to generate a functional mock server. | | + +## CONFIG OPTIONS These options may be applied 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/jaxrs-cxf.md b/docs/generators/jaxrs-cxf.md index 80b178858a3..f3cb09d4176 100644 --- a/docs/generators/jaxrs-cxf.md +++ b/docs/generators/jaxrs-cxf.md @@ -1,8 +1,16 @@ --- -title: Config Options for jaxrs-cxf -sidebar_label: jaxrs-cxf +title: Documentation for the jaxrs-cxf Generator --- +## METADATA + +| Property | Value | Notes | +| -------- | ----- | ----- | +| generator name | jaxrs-cxf | pass this to the generate command after -g | +| generator type | SERVER | | +| helpTxt | Generates a Java JAXRS Server application based on Apache CXF framework. | | + +## CONFIG OPTIONS These options may be applied 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/jaxrs-jersey.md b/docs/generators/jaxrs-jersey.md index 15584410d1f..086f079c059 100644 --- a/docs/generators/jaxrs-jersey.md +++ b/docs/generators/jaxrs-jersey.md @@ -1,8 +1,16 @@ --- -title: Config Options for jaxrs-jersey -sidebar_label: jaxrs-jersey +title: Documentation for the jaxrs-jersey Generator --- +## METADATA + +| Property | Value | Notes | +| -------- | ----- | ----- | +| generator name | jaxrs-jersey | pass this to the generate command after -g | +| generator type | SERVER | | +| helpTxt | Generates a Java JAXRS Server application based on Jersey framework. | | + +## CONFIG OPTIONS These options may be applied 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/jaxrs-resteasy-eap.md b/docs/generators/jaxrs-resteasy-eap.md index 247353cbb32..3670d584186 100644 --- a/docs/generators/jaxrs-resteasy-eap.md +++ b/docs/generators/jaxrs-resteasy-eap.md @@ -1,8 +1,16 @@ --- -title: Config Options for jaxrs-resteasy-eap -sidebar_label: jaxrs-resteasy-eap +title: Documentation for the jaxrs-resteasy-eap Generator --- +## METADATA + +| Property | Value | Notes | +| -------- | ----- | ----- | +| generator name | jaxrs-resteasy-eap | pass this to the generate command after -g | +| generator type | SERVER | | +| helpTxt | Generates a Java JAXRS-Resteasy Server application. | | + +## CONFIG OPTIONS These options may be applied 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/jaxrs-resteasy.md b/docs/generators/jaxrs-resteasy.md index ff9fab072fd..bf56de2f235 100644 --- a/docs/generators/jaxrs-resteasy.md +++ b/docs/generators/jaxrs-resteasy.md @@ -1,8 +1,16 @@ --- -title: Config Options for jaxrs-resteasy -sidebar_label: jaxrs-resteasy +title: Documentation for the jaxrs-resteasy Generator --- +## METADATA + +| Property | Value | Notes | +| -------- | ----- | ----- | +| generator name | jaxrs-resteasy | pass this to the generate command after -g | +| generator type | SERVER | | +| helpTxt | Generates a Java JAXRS-Resteasy Server application. | | + +## CONFIG OPTIONS These options may be applied 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/jaxrs-spec.md b/docs/generators/jaxrs-spec.md index a29e8a93178..84d8b47d501 100644 --- a/docs/generators/jaxrs-spec.md +++ b/docs/generators/jaxrs-spec.md @@ -1,8 +1,16 @@ --- -title: Config Options for jaxrs-spec -sidebar_label: jaxrs-spec +title: Documentation for the jaxrs-spec Generator --- +## METADATA + +| Property | Value | Notes | +| -------- | ----- | ----- | +| generator name | jaxrs-spec | pass this to the generate command after -g | +| generator type | SERVER | | +| helpTxt | Generates a Java JAXRS Server according to JAXRS 2.0 specification. | | + +## CONFIG OPTIONS These options may be applied 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/jmeter.md b/docs/generators/jmeter.md index 71584a1e793..e47e7fef177 100644 --- a/docs/generators/jmeter.md +++ b/docs/generators/jmeter.md @@ -1,8 +1,16 @@ --- -title: Config Options for jmeter -sidebar_label: jmeter +title: Documentation for the jmeter Generator --- +## METADATA + +| Property | Value | Notes | +| -------- | ----- | ----- | +| generator name | jmeter | pass this to the generate command after -g | +| generator type | CLIENT | | +| helpTxt | Generates a JMeter .jmx file. | | + +## CONFIG OPTIONS These options may be applied 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/k6.md b/docs/generators/k6.md index 529527a890c..a23aec49d2d 100644 --- a/docs/generators/k6.md +++ b/docs/generators/k6.md @@ -1,8 +1,16 @@ --- -title: Config Options for k6 -sidebar_label: k6 +title: Documentation for the k6 Generator --- +## METADATA + +| Property | Value | Notes | +| -------- | ----- | ----- | +| generator name | k6 | pass this to the generate command after -g | +| generator type | CLIENT | | +| helpTxt | Generates a k6 script (beta). | | + +## CONFIG OPTIONS These options may be applied 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/kotlin-server-deprecated.md b/docs/generators/kotlin-server-deprecated.md index 7e53620aa6e..79e12009c63 100644 --- a/docs/generators/kotlin-server-deprecated.md +++ b/docs/generators/kotlin-server-deprecated.md @@ -1,8 +1,16 @@ --- -title: Config Options for kotlin-server-deprecated -sidebar_label: kotlin-server-deprecated +title: Documentation for the kotlin-server-deprecated Generator --- +## METADATA + +| Property | Value | Notes | +| -------- | ----- | ----- | +| generator name | kotlin-server-deprecated | pass this to the generate command after -g | +| generator type | SERVER | | +| helpTxt | Generates a Kotlin server (Ktor v1.1.3). IMPORTANT: this generator has been deprecated. Please migrate to `kotlin-server` which supports Ktor v1.5.2+. | | + +## CONFIG OPTIONS These options may be applied 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/kotlin-server.md b/docs/generators/kotlin-server.md index 0c0228d8a8c..95dce36a027 100644 --- a/docs/generators/kotlin-server.md +++ b/docs/generators/kotlin-server.md @@ -1,8 +1,16 @@ --- -title: Config Options for kotlin-server -sidebar_label: kotlin-server +title: Documentation for the kotlin-server Generator --- +## METADATA + +| Property | Value | Notes | +| -------- | ----- | ----- | +| generator name | kotlin-server | pass this to the generate command after -g | +| generator type | SERVER | | +| helpTxt | Generates a Kotlin server. | | + +## CONFIG OPTIONS These options may be applied 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/kotlin-spring.md b/docs/generators/kotlin-spring.md index 5cd67ff64aa..d09124f4a7f 100644 --- a/docs/generators/kotlin-spring.md +++ b/docs/generators/kotlin-spring.md @@ -1,8 +1,16 @@ --- -title: Config Options for kotlin-spring -sidebar_label: kotlin-spring +title: Documentation for the kotlin-spring Generator --- +## METADATA + +| Property | Value | Notes | +| -------- | ----- | ----- | +| generator name | kotlin-spring | pass this to the generate command after -g | +| generator type | SERVER | | +| helpTxt | Generates a Kotlin Spring application. | | + +## CONFIG OPTIONS These options may be applied 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/kotlin-vertx.md b/docs/generators/kotlin-vertx.md index 02d608e5274..174d19f1669 100644 --- a/docs/generators/kotlin-vertx.md +++ b/docs/generators/kotlin-vertx.md @@ -1,8 +1,16 @@ --- -title: Config Options for kotlin-vertx -sidebar_label: kotlin-vertx +title: Documentation for the kotlin-vertx Generator --- +## METADATA + +| Property | Value | Notes | +| -------- | ----- | ----- | +| generator name | kotlin-vertx | pass this to the generate command after -g | +| generator type | SERVER | | +| helpTxt | Generates a kotlin-vertx server. | | + +## CONFIG OPTIONS These options may be applied 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/kotlin.md b/docs/generators/kotlin.md index 786ff7013eb..31f9601161d 100644 --- a/docs/generators/kotlin.md +++ b/docs/generators/kotlin.md @@ -1,8 +1,16 @@ --- -title: Config Options for kotlin -sidebar_label: kotlin +title: Documentation for the kotlin Generator --- +## METADATA + +| Property | Value | Notes | +| -------- | ----- | ----- | +| generator name | kotlin | pass this to the generate command after -g | +| generator type | CLIENT | | +| helpTxt | Generates a Kotlin client. | | + +## CONFIG OPTIONS These options may be applied 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/ktorm-schema.md b/docs/generators/ktorm-schema.md index 7a45b88b69a..163fce14c15 100644 --- a/docs/generators/ktorm-schema.md +++ b/docs/generators/ktorm-schema.md @@ -1,8 +1,16 @@ --- -title: Config Options for ktorm-schema -sidebar_label: ktorm-schema +title: Documentation for the ktorm-schema Generator --- +## METADATA + +| Property | Value | Notes | +| -------- | ----- | ----- | +| generator name | ktorm-schema | pass this to the generate command after -g | +| generator type | SCHEMA | | +| helpTxt | Generates a kotlin-ktorm schema (beta) | | + +## CONFIG OPTIONS These options may be applied 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/lua.md b/docs/generators/lua.md index 6f9f4a80eaf..3f4e6e34c6c 100644 --- a/docs/generators/lua.md +++ b/docs/generators/lua.md @@ -1,8 +1,16 @@ --- -title: Config Options for lua -sidebar_label: lua +title: Documentation for the lua Generator --- +## METADATA + +| Property | Value | Notes | +| -------- | ----- | ----- | +| generator name | lua | pass this to the generate command after -g | +| generator type | CLIENT | | +| helpTxt | Generates a Lua client library (beta). | | + +## CONFIG OPTIONS These options may be applied 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/markdown.md b/docs/generators/markdown.md index 4d87a35f964..87e922f1b9d 100644 --- a/docs/generators/markdown.md +++ b/docs/generators/markdown.md @@ -1,8 +1,16 @@ --- -title: Config Options for markdown -sidebar_label: markdown +title: Documentation for the markdown Generator --- +## METADATA + +| Property | Value | Notes | +| -------- | ----- | ----- | +| generator name | markdown | pass this to the generate command after -g | +| generator type | DOCUMENTATION | | +| helpTxt | Generates a markdown documentation. | | + +## CONFIG OPTIONS These options may be applied 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/mysql-schema.md b/docs/generators/mysql-schema.md index 8526ade4f06..3499563f5a8 100644 --- a/docs/generators/mysql-schema.md +++ b/docs/generators/mysql-schema.md @@ -1,8 +1,16 @@ --- -title: Config Options for mysql-schema -sidebar_label: mysql-schema +title: Documentation for the mysql-schema Generator --- +## METADATA + +| Property | Value | Notes | +| -------- | ----- | ----- | +| generator name | mysql-schema | pass this to the generate command after -g | +| generator type | SCHEMA | | +| helpTxt | Generates a MySQL schema based on the model or schema defined in the OpenAPI specification (v2, v3). | | + +## CONFIG OPTIONS These options may be applied 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/nim.md b/docs/generators/nim.md index 3d90efad159..77a6d5e9046 100644 --- a/docs/generators/nim.md +++ b/docs/generators/nim.md @@ -1,8 +1,16 @@ --- -title: Config Options for nim -sidebar_label: nim +title: Documentation for the nim Generator --- +## METADATA + +| Property | Value | Notes | +| -------- | ----- | ----- | +| generator name | nim | pass this to the generate command after -g | +| generator type | CLIENT | | +| helpTxt | Generates a nim client (beta). | | + +## CONFIG OPTIONS These options may be applied 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/nodejs-express-server.md b/docs/generators/nodejs-express-server.md index 9fffa3c28b7..f2bca510334 100644 --- a/docs/generators/nodejs-express-server.md +++ b/docs/generators/nodejs-express-server.md @@ -1,8 +1,16 @@ --- -title: Config Options for nodejs-express-server -sidebar_label: nodejs-express-server +title: Documentation for the nodejs-express-server Generator --- +## METADATA + +| Property | Value | Notes | +| -------- | ----- | ----- | +| generator name | nodejs-express-server | pass this to the generate command after -g | +| generator type | SERVER | | +| helpTxt | Generates a NodeJS Express server (alpha). IMPORTANT: this generator may subject to breaking changes without further notice). | | + +## CONFIG OPTIONS These options may be applied 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/objc.md b/docs/generators/objc.md index ad51253f978..fa4c1350801 100644 --- a/docs/generators/objc.md +++ b/docs/generators/objc.md @@ -1,8 +1,16 @@ --- -title: Config Options for objc -sidebar_label: objc +title: Documentation for the objc Generator --- +## METADATA + +| Property | Value | Notes | +| -------- | ----- | ----- | +| generator name | objc | pass this to the generate command after -g | +| generator type | CLIENT | | +| helpTxt | Generates an Objective-C client library. | | + +## CONFIG OPTIONS These options may be applied 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/ocaml.md b/docs/generators/ocaml.md index 597f07b8411..a453f108792 100644 --- a/docs/generators/ocaml.md +++ b/docs/generators/ocaml.md @@ -1,8 +1,16 @@ --- -title: Config Options for ocaml -sidebar_label: ocaml +title: Documentation for the ocaml Generator --- +## METADATA + +| Property | Value | Notes | +| -------- | ----- | ----- | +| generator name | ocaml | pass this to the generate command after -g | +| generator type | CLIENT | | +| helpTxt | Generates an OCaml client library (beta). | | + +## CONFIG OPTIONS These options may be applied 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/openapi-yaml.md b/docs/generators/openapi-yaml.md index 4476c790000..db86e36ac3d 100644 --- a/docs/generators/openapi-yaml.md +++ b/docs/generators/openapi-yaml.md @@ -1,8 +1,16 @@ --- -title: Config Options for openapi-yaml -sidebar_label: openapi-yaml +title: Documentation for the openapi-yaml Generator --- +## METADATA + +| Property | Value | Notes | +| -------- | ----- | ----- | +| generator name | openapi-yaml | pass this to the generate command after -g | +| generator type | DOCUMENTATION | | +| helpTxt | Creates a static openapi.yaml file (OpenAPI spec v3). | | + +## CONFIG OPTIONS These options may be applied 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/openapi.md b/docs/generators/openapi.md index 53ea3bf812c..754d65ebc26 100644 --- a/docs/generators/openapi.md +++ b/docs/generators/openapi.md @@ -1,8 +1,16 @@ --- -title: Config Options for openapi -sidebar_label: openapi +title: Documentation for the openapi Generator --- +## METADATA + +| Property | Value | Notes | +| -------- | ----- | ----- | +| generator name | openapi | pass this to the generate command after -g | +| generator type | DOCUMENTATION | | +| helpTxt | Creates a static openapi.json file (OpenAPI spec v3.0). | | + +## CONFIG OPTIONS These options may be applied 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/perl.md b/docs/generators/perl.md index 910abd78432..5d9c89a3a10 100644 --- a/docs/generators/perl.md +++ b/docs/generators/perl.md @@ -1,8 +1,16 @@ --- -title: Config Options for perl -sidebar_label: perl +title: Documentation for the perl Generator --- +## METADATA + +| Property | Value | Notes | +| -------- | ----- | ----- | +| generator name | perl | pass this to the generate command after -g | +| generator type | CLIENT | | +| helpTxt | Generates a Perl client library. | | + +## CONFIG OPTIONS These options may be applied 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/php-dt.md b/docs/generators/php-dt.md index a4a6eac2b73..293940f6ca0 100644 --- a/docs/generators/php-dt.md +++ b/docs/generators/php-dt.md @@ -1,8 +1,16 @@ --- -title: Config Options for php-dt -sidebar_label: php-dt +title: Documentation for the php-dt Generator --- +## METADATA + +| Property | Value | Notes | +| -------- | ----- | ----- | +| generator name | php-dt | pass this to the generate command after -g | +| generator type | CLIENT | | +| helpTxt | Generates a PHP client relying on Data Transfer ( https://github.com/Articus/DataTransfer ) and compliant with PSR-7, PSR-11, PSR-17 and PSR-18. | | + +## CONFIG OPTIONS These options may be applied 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/php-laravel.md b/docs/generators/php-laravel.md index 09e61d56c13..bd374554c82 100644 --- a/docs/generators/php-laravel.md +++ b/docs/generators/php-laravel.md @@ -1,8 +1,16 @@ --- -title: Config Options for php-laravel -sidebar_label: php-laravel +title: Documentation for the php-laravel Generator --- +## METADATA + +| Property | Value | Notes | +| -------- | ----- | ----- | +| generator name | php-laravel | pass this to the generate command after -g | +| generator type | SERVER | | +| helpTxt | Generates a PHP laravel server library. | | + +## CONFIG OPTIONS These options may be applied 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/php-lumen.md b/docs/generators/php-lumen.md index 562b26a589d..1b91b92fd9a 100644 --- a/docs/generators/php-lumen.md +++ b/docs/generators/php-lumen.md @@ -1,8 +1,16 @@ --- -title: Config Options for php-lumen -sidebar_label: php-lumen +title: Documentation for the php-lumen Generator --- +## METADATA + +| Property | Value | Notes | +| -------- | ----- | ----- | +| generator name | php-lumen | pass this to the generate command after -g | +| generator type | SERVER | | +| helpTxt | Generates a PHP Lumen server library. | | + +## CONFIG OPTIONS These options may be applied 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/php-mezzio-ph.md b/docs/generators/php-mezzio-ph.md index 7abb3408bca..71268386534 100644 --- a/docs/generators/php-mezzio-ph.md +++ b/docs/generators/php-mezzio-ph.md @@ -1,8 +1,16 @@ --- -title: Config Options for php-mezzio-ph -sidebar_label: php-mezzio-ph +title: Documentation for the php-mezzio-ph Generator --- +## METADATA + +| Property | Value | Notes | +| -------- | ----- | ----- | +| generator name | php-mezzio-ph | pass this to the generate command after -g | +| generator type | SERVER | | +| helpTxt | Generates PHP server stub using Mezzio ( https://docs.mezzio.dev/mezzio/ ) and Path Handler ( https://github.com/Articus/PathHandler ). | | + +## CONFIG OPTIONS These options may be applied 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/php-silex-deprecated.md b/docs/generators/php-silex-deprecated.md index 9b4d5b39b63..e9af8da6621 100644 --- a/docs/generators/php-silex-deprecated.md +++ b/docs/generators/php-silex-deprecated.md @@ -1,8 +1,16 @@ --- -title: Config Options for php-silex-deprecated -sidebar_label: php-silex-deprecated +title: Documentation for the php-silex-deprecated Generator --- +## METADATA + +| Property | Value | Notes | +| -------- | ----- | ----- | +| generator name | php-silex-deprecated | pass this to the generate command after -g | +| generator type | SERVER | | +| helpTxt | Generates a PHP Silex server library. IMPORTANT NOTE: this generator is no longer actively maintained. | | + +## CONFIG OPTIONS These options may be applied 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/php-slim-deprecated.md b/docs/generators/php-slim-deprecated.md index 15c4d36ba80..5e88e4e684a 100644 --- a/docs/generators/php-slim-deprecated.md +++ b/docs/generators/php-slim-deprecated.md @@ -1,8 +1,16 @@ --- -title: Config Options for php-slim-deprecated -sidebar_label: php-slim-deprecated +title: Documentation for the php-slim-deprecated Generator --- +## METADATA + +| Property | Value | Notes | +| -------- | ----- | ----- | +| generator name | php-slim-deprecated | pass this to the generate command after -g | +| generator type | SERVER | | +| helpTxt | Generates a PHP Slim Framework server library. IMPORTANT NOTE: this generator (Slim 3.x) is no longer actively maintained so please use 'php-slim4' generator instead. | | + +## CONFIG OPTIONS These options may be applied 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/php-slim4.md b/docs/generators/php-slim4.md index ca1bd3b6a10..ae8676e2d9a 100644 --- a/docs/generators/php-slim4.md +++ b/docs/generators/php-slim4.md @@ -1,8 +1,16 @@ --- -title: Config Options for php-slim4 -sidebar_label: php-slim4 +title: Documentation for the php-slim4 Generator --- +## METADATA + +| Property | Value | Notes | +| -------- | ----- | ----- | +| generator name | php-slim4 | pass this to the generate command after -g | +| generator type | SERVER | | +| helpTxt | Generates a PHP Slim 4 Framework server library(with Mock server). | | + +## CONFIG OPTIONS These options may be applied 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/php-symfony.md b/docs/generators/php-symfony.md index 0a231dbd2e4..8ed3be46e39 100644 --- a/docs/generators/php-symfony.md +++ b/docs/generators/php-symfony.md @@ -1,8 +1,16 @@ --- -title: Config Options for php-symfony -sidebar_label: php-symfony +title: Documentation for the php-symfony Generator --- +## METADATA + +| Property | Value | Notes | +| -------- | ----- | ----- | +| generator name | php-symfony | pass this to the generate command after -g | +| generator type | SERVER | | +| helpTxt | Generates a PHP Symfony server bundle. | | + +## CONFIG OPTIONS These options may be applied 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/php.md b/docs/generators/php.md index c84e12c36f6..b9a93234cb2 100644 --- a/docs/generators/php.md +++ b/docs/generators/php.md @@ -1,8 +1,16 @@ --- -title: Config Options for php -sidebar_label: php +title: Documentation for the php Generator --- +## METADATA + +| Property | Value | Notes | +| -------- | ----- | ----- | +| generator name | php | pass this to the generate command after -g | +| generator type | CLIENT | | +| helpTxt | Generates a PHP client library. | | + +## CONFIG OPTIONS These options may be applied 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/plantuml.md b/docs/generators/plantuml.md index 7a37ad0d187..b2c4c230c0b 100644 --- a/docs/generators/plantuml.md +++ b/docs/generators/plantuml.md @@ -1,8 +1,16 @@ --- -title: Config Options for plantuml -sidebar_label: plantuml +title: Documentation for the plantuml Generator --- +## METADATA + +| Property | Value | Notes | +| -------- | ----- | ----- | +| generator name | plantuml | pass this to the generate command after -g | +| generator type | DOCUMENTATION | | +| helpTxt | Generates a plantuml documentation. | | + +## CONFIG OPTIONS These options may be applied 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/powershell.md b/docs/generators/powershell.md index c822e241889..36d7ba9e54d 100644 --- a/docs/generators/powershell.md +++ b/docs/generators/powershell.md @@ -1,8 +1,16 @@ --- -title: Config Options for powershell -sidebar_label: powershell +title: Documentation for the powershell Generator --- +## METADATA + +| Property | Value | Notes | +| -------- | ----- | ----- | +| generator name | powershell | pass this to the generate command after -g | +| generator type | CLIENT | | +| helpTxt | Generates a PowerShell API client (beta) | | + +## CONFIG OPTIONS These options may be applied 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/protobuf-schema.md b/docs/generators/protobuf-schema.md index a7d1f1d095b..2f350f1a1b0 100644 --- a/docs/generators/protobuf-schema.md +++ b/docs/generators/protobuf-schema.md @@ -1,8 +1,16 @@ --- -title: Config Options for protobuf-schema -sidebar_label: protobuf-schema +title: Documentation for the protobuf-schema Generator --- +## METADATA + +| Property | Value | Notes | +| -------- | ----- | ----- | +| generator name | protobuf-schema | pass this to the generate command after -g | +| generator type | SCHEMA | | +| helpTxt | Generates gRPC and protocol buffer schema files (beta) | | + +## CONFIG OPTIONS These options may be applied 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 14ffd174221..fdfdf70f306 100644 --- a/docs/generators/python-aiohttp.md +++ b/docs/generators/python-aiohttp.md @@ -1,8 +1,16 @@ --- -title: Config Options for python-aiohttp -sidebar_label: python-aiohttp +title: Documentation for the python-aiohttp Generator --- +## METADATA + +| Property | Value | Notes | +| -------- | ----- | ----- | +| generator name | python-aiohttp | pass this to the generate command after -g | +| generator type | SERVER | | +| helpTxt | Generates a Python server library using the Connexion project. By default, it will also generate service classes -- which you can disable with the `-Dnoservice` environment variable. | | + +## CONFIG OPTIONS These options may be applied 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-blueplanet.md b/docs/generators/python-blueplanet.md index 049e3424ebb..f8f6d4f6307 100644 --- a/docs/generators/python-blueplanet.md +++ b/docs/generators/python-blueplanet.md @@ -1,8 +1,16 @@ --- -title: Config Options for python-blueplanet -sidebar_label: python-blueplanet +title: Documentation for the python-blueplanet Generator --- +## METADATA + +| Property | Value | Notes | +| -------- | ----- | ----- | +| generator name | python-blueplanet | pass this to the generate command after -g | +| generator type | SERVER | | +| helpTxt | Generates a Python server library using the Connexion project. By default, it will also generate service classes -- which you can disable with the `-Dnoservice` environment variable. | | + +## CONFIG OPTIONS These options may be applied 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-experimental.md b/docs/generators/python-experimental.md index e61a03a4e60..e026fdf032a 100644 --- a/docs/generators/python-experimental.md +++ b/docs/generators/python-experimental.md @@ -1,8 +1,16 @@ --- -title: Config Options for python-experimental -sidebar_label: python-experimental +title: Documentation for the python-experimental Generator --- +## METADATA + +| Property | Value | Notes | +| -------- | ----- | ----- | +| generator name | python-experimental | pass this to the generate command after -g | +| generator type | CLIENT | | +| helpTxt | Generates a Python client library

Features in this generator:
- type hints on endpoints and model creation
- model parameter names use the spec defined keys and cases
- robust composition (oneOf/anyOf/allOf) where paload data is stored in one instance only
- endpoint parameter names use the spec defined keys and cases
- inline schemas are supported at any location including composition
- multiple content types supported in request body and response bodies
- run time type checking
- quicker load time for python modules (a single endpoint can be imported and used without loading others)
- all instances of schemas dynamically inherit from all matching schemas so one can use isinstance to check if validation passed
- composed schemas with type constraints supported (type:object + oneOf/anyOf/allOf)
- schemas are not coerced/cast. For example string + date are both stored as string, and there is a date accessor
- Exceptions: int/float is stored as Decimal, When receiving data from headers it will start as str and may need to be cast for example to int | | + +## CONFIG OPTIONS These options may be applied 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-fastapi.md b/docs/generators/python-fastapi.md index 4e321ff9e59..bb88a406076 100644 --- a/docs/generators/python-fastapi.md +++ b/docs/generators/python-fastapi.md @@ -1,8 +1,16 @@ --- -title: Config Options for python-fastapi -sidebar_label: python-fastapi +title: Documentation for the python-fastapi Generator --- +## METADATA + +| Property | Value | Notes | +| -------- | ----- | ----- | +| generator name | python-fastapi | pass this to the generate command after -g | +| generator type | SERVER | | +| helpTxt | Generates a Python FastAPI server (beta). | | + +## CONFIG OPTIONS These options may be applied 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-flask.md b/docs/generators/python-flask.md index a0a5f44b20a..b53c86fded1 100644 --- a/docs/generators/python-flask.md +++ b/docs/generators/python-flask.md @@ -1,8 +1,16 @@ --- -title: Config Options for python-flask -sidebar_label: python-flask +title: Documentation for the python-flask Generator --- +## METADATA + +| Property | Value | Notes | +| -------- | ----- | ----- | +| generator name | python-flask | pass this to the generate command after -g | +| generator type | SERVER | | +| helpTxt | Generates a Python server library using the Connexion project. By default, it will also generate service classes -- which you can disable with the `-Dnoservice` environment variable. | | + +## CONFIG OPTIONS These options may be applied 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-legacy.md b/docs/generators/python-legacy.md index a341d478882..14821d0ae1c 100644 --- a/docs/generators/python-legacy.md +++ b/docs/generators/python-legacy.md @@ -1,8 +1,16 @@ --- -title: Config Options for python-legacy -sidebar_label: python-legacy +title: Documentation for the python-legacy Generator --- +## METADATA + +| Property | Value | Notes | +| -------- | ----- | ----- | +| generator name | python-legacy | pass this to the generate command after -g | +| generator type | CLIENT | | +| helpTxt | Generates a Python client library. | | + +## CONFIG OPTIONS These options may be applied 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.md b/docs/generators/python.md index fe60f0e511c..607c71a2604 100644 --- a/docs/generators/python.md +++ b/docs/generators/python.md @@ -1,8 +1,16 @@ --- -title: Config Options for python -sidebar_label: python +title: Documentation for the python Generator --- +## METADATA + +| Property | Value | Notes | +| -------- | ----- | ----- | +| generator name | python | pass this to the generate command after -g | +| generator type | CLIENT | | +| helpTxt | Generates a Python client library. | | + +## CONFIG OPTIONS These options may be applied 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/r.md b/docs/generators/r.md index 69613835612..d2ee1ea6836 100644 --- a/docs/generators/r.md +++ b/docs/generators/r.md @@ -1,8 +1,16 @@ --- -title: Config Options for r -sidebar_label: r +title: Documentation for the r Generator --- +## METADATA + +| Property | Value | Notes | +| -------- | ----- | ----- | +| generator name | r | pass this to the generate command after -g | +| generator type | CLIENT | | +| helpTxt | Generates a R client library (beta). | | + +## CONFIG OPTIONS These options may be applied 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-on-rails.md b/docs/generators/ruby-on-rails.md index 5c25cf1451b..f0be7a29e13 100644 --- a/docs/generators/ruby-on-rails.md +++ b/docs/generators/ruby-on-rails.md @@ -1,8 +1,16 @@ --- -title: Config Options for ruby-on-rails -sidebar_label: ruby-on-rails +title: Documentation for the ruby-on-rails Generator --- +## METADATA + +| Property | Value | Notes | +| -------- | ----- | ----- | +| generator name | ruby-on-rails | pass this to the generate command after -g | +| generator type | SERVER | | +| helpTxt | Generates a Ruby on Rails (v5) server library. | | + +## CONFIG OPTIONS These options may be applied 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-sinatra.md b/docs/generators/ruby-sinatra.md index 58043cfafc5..f58b4b948b1 100644 --- a/docs/generators/ruby-sinatra.md +++ b/docs/generators/ruby-sinatra.md @@ -1,8 +1,16 @@ --- -title: Config Options for ruby-sinatra -sidebar_label: ruby-sinatra +title: Documentation for the ruby-sinatra Generator --- +## METADATA + +| Property | Value | Notes | +| -------- | ----- | ----- | +| generator name | ruby-sinatra | pass this to the generate command after -g | +| generator type | SERVER | | +| helpTxt | Generates a Ruby Sinatra server library. | | + +## CONFIG OPTIONS These options may be applied 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 6937905b9e3..56c094bbd9f 100644 --- a/docs/generators/ruby.md +++ b/docs/generators/ruby.md @@ -1,8 +1,16 @@ --- -title: Config Options for ruby -sidebar_label: ruby +title: Documentation for the ruby Generator --- +## METADATA + +| Property | Value | Notes | +| -------- | ----- | ----- | +| generator name | ruby | pass this to the generate command after -g | +| generator type | CLIENT | | +| helpTxt | Generates a Ruby client library. | | + +## CONFIG OPTIONS These options may be applied 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/rust-server.md b/docs/generators/rust-server.md index 1d13b032104..7822aa5417c 100644 --- a/docs/generators/rust-server.md +++ b/docs/generators/rust-server.md @@ -1,8 +1,16 @@ --- -title: Config Options for rust-server -sidebar_label: rust-server +title: Documentation for the rust-server Generator --- +## METADATA + +| Property | Value | Notes | +| -------- | ----- | ----- | +| generator name | rust-server | pass this to the generate command after -g | +| generator type | SERVER | | +| helpTxt | Generates a Rust client/server library (beta) using the openapi-generator project. | | + +## CONFIG OPTIONS These options may be applied 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/rust.md b/docs/generators/rust.md index dc57794b8d0..44b63aee0ec 100644 --- a/docs/generators/rust.md +++ b/docs/generators/rust.md @@ -1,8 +1,16 @@ --- -title: Config Options for rust -sidebar_label: rust +title: Documentation for the rust Generator --- +## METADATA + +| Property | Value | Notes | +| -------- | ----- | ----- | +| generator name | rust | pass this to the generate command after -g | +| generator type | CLIENT | | +| helpTxt | Generates a Rust client library (beta). | | + +## CONFIG OPTIONS These options may be applied 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/scala-akka-http-server.md b/docs/generators/scala-akka-http-server.md index 3d27821c231..9c35ef92e7d 100644 --- a/docs/generators/scala-akka-http-server.md +++ b/docs/generators/scala-akka-http-server.md @@ -1,8 +1,16 @@ --- -title: Config Options for scala-akka-http-server -sidebar_label: scala-akka-http-server +title: Documentation for the scala-akka-http-server Generator --- +## METADATA + +| Property | Value | Notes | +| -------- | ----- | ----- | +| generator name | scala-akka-http-server | pass this to the generate command after -g | +| generator type | SERVER | | +| helpTxt | Generates a scala-akka-http server (beta). | | + +## CONFIG OPTIONS These options may be applied 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/scala-akka.md b/docs/generators/scala-akka.md index 1cc19c6216d..cf8b6909aca 100644 --- a/docs/generators/scala-akka.md +++ b/docs/generators/scala-akka.md @@ -1,8 +1,16 @@ --- -title: Config Options for scala-akka -sidebar_label: scala-akka +title: Documentation for the scala-akka Generator --- +## METADATA + +| Property | Value | Notes | +| -------- | ----- | ----- | +| generator name | scala-akka | pass this to the generate command after -g | +| generator type | CLIENT | | +| helpTxt | Generates a Scala client library (beta) base on Akka/Spray. | | + +## CONFIG OPTIONS These options may be applied 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/scala-finch.md b/docs/generators/scala-finch.md index 5d2bdded42a..9796e5d50fd 100644 --- a/docs/generators/scala-finch.md +++ b/docs/generators/scala-finch.md @@ -1,8 +1,16 @@ --- -title: Config Options for scala-finch -sidebar_label: scala-finch +title: Documentation for the scala-finch Generator --- +## METADATA + +| Property | Value | Notes | +| -------- | ----- | ----- | +| generator name | scala-finch | pass this to the generate command after -g | +| generator type | SERVER | | +| helpTxt | Generates a Scala server application with Finch. | | + +## CONFIG OPTIONS These options may be applied 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/scala-gatling.md b/docs/generators/scala-gatling.md index 6daaef5d657..19cd4528952 100644 --- a/docs/generators/scala-gatling.md +++ b/docs/generators/scala-gatling.md @@ -1,8 +1,16 @@ --- -title: Config Options for scala-gatling -sidebar_label: scala-gatling +title: Documentation for the scala-gatling Generator --- +## METADATA + +| Property | Value | Notes | +| -------- | ----- | ----- | +| generator name | scala-gatling | pass this to the generate command after -g | +| generator type | CLIENT | | +| helpTxt | Generates a gatling simulation library (beta). | | + +## CONFIG OPTIONS These options may be applied 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/scala-httpclient-deprecated.md b/docs/generators/scala-httpclient-deprecated.md index 4bd12dca955..af714b42ed2 100644 --- a/docs/generators/scala-httpclient-deprecated.md +++ b/docs/generators/scala-httpclient-deprecated.md @@ -1,8 +1,16 @@ --- -title: Config Options for scala-httpclient-deprecated -sidebar_label: scala-httpclient-deprecated +title: Documentation for the scala-httpclient-deprecated Generator --- +## METADATA + +| Property | Value | Notes | +| -------- | ----- | ----- | +| generator name | scala-httpclient-deprecated | pass this to the generate command after -g | +| generator type | CLIENT | | +| helpTxt | Generates a Scala client library (beta). IMPORTANT: This generator is no longer actively maintained and will be deprecated. PLease use 'scala-akka' generator instead. | | + +## CONFIG OPTIONS These options may be applied 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/scala-lagom-server.md b/docs/generators/scala-lagom-server.md index ed197a23e5e..aba88bb57ee 100644 --- a/docs/generators/scala-lagom-server.md +++ b/docs/generators/scala-lagom-server.md @@ -1,8 +1,16 @@ --- -title: Config Options for scala-lagom-server -sidebar_label: scala-lagom-server +title: Documentation for the scala-lagom-server Generator --- +## METADATA + +| Property | Value | Notes | +| -------- | ----- | ----- | +| generator name | scala-lagom-server | pass this to the generate command after -g | +| generator type | SERVER | | +| helpTxt | Generates a Lagom API server (Beta) in scala | | + +## CONFIG OPTIONS These options may be applied 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/scala-play-server.md b/docs/generators/scala-play-server.md index aeab7fd2538..845b9a233b8 100644 --- a/docs/generators/scala-play-server.md +++ b/docs/generators/scala-play-server.md @@ -1,8 +1,16 @@ --- -title: Config Options for scala-play-server -sidebar_label: scala-play-server +title: Documentation for the scala-play-server Generator --- +## METADATA + +| Property | Value | Notes | +| -------- | ----- | ----- | +| generator name | scala-play-server | pass this to the generate command after -g | +| generator type | SERVER | | +| helpTxt | Generates a Scala server application (beta) with Play Framework. | | + +## CONFIG OPTIONS These options may be applied 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/scala-sttp.md b/docs/generators/scala-sttp.md index 9425f8f5c97..1befd28b70e 100644 --- a/docs/generators/scala-sttp.md +++ b/docs/generators/scala-sttp.md @@ -1,8 +1,16 @@ --- -title: Config Options for scala-sttp -sidebar_label: scala-sttp +title: Documentation for the scala-sttp Generator --- +## METADATA + +| Property | Value | Notes | +| -------- | ----- | ----- | +| generator name | scala-sttp | pass this to the generate command after -g | +| generator type | CLIENT | | +| helpTxt | Generates a Scala client library (beta) based on Sttp. | | + +## CONFIG OPTIONS These options may be applied 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/scalatra.md b/docs/generators/scalatra.md index 9159c798f23..56bef75b6cc 100644 --- a/docs/generators/scalatra.md +++ b/docs/generators/scalatra.md @@ -1,8 +1,16 @@ --- -title: Config Options for scalatra -sidebar_label: scalatra +title: Documentation for the scalatra Generator --- +## METADATA + +| Property | Value | Notes | +| -------- | ----- | ----- | +| generator name | scalatra | pass this to the generate command after -g | +| generator type | SERVER | | +| helpTxt | Generates a Scala server application with Scalatra. | | + +## CONFIG OPTIONS These options may be applied 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/scalaz.md b/docs/generators/scalaz.md index 18520f5e3b3..7c356c9f8e2 100644 --- a/docs/generators/scalaz.md +++ b/docs/generators/scalaz.md @@ -1,8 +1,16 @@ --- -title: Config Options for scalaz -sidebar_label: scalaz +title: Documentation for the scalaz Generator --- +## METADATA + +| Property | Value | Notes | +| -------- | ----- | ----- | +| generator name | scalaz | pass this to the generate command after -g | +| generator type | CLIENT | | +| helpTxt | Generates a Scalaz client library (beta) that uses http4s | | + +## CONFIG OPTIONS These options may be applied 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/spring.md b/docs/generators/spring.md index 34e4a6a266c..7623c432a75 100644 --- a/docs/generators/spring.md +++ b/docs/generators/spring.md @@ -1,8 +1,16 @@ --- -title: Config Options for spring -sidebar_label: spring +title: Documentation for the spring Generator --- +## METADATA + +| Property | Value | Notes | +| -------- | ----- | ----- | +| generator name | spring | pass this to the generate command after -g | +| generator type | SERVER | | +| helpTxt | Generates a Java SpringBoot Server application using the SpringFox integration. | | + +## CONFIG OPTIONS These options may be applied 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/swift4-deprecated.md b/docs/generators/swift4-deprecated.md index cf1e1f65df4..7743ddf5a45 100644 --- a/docs/generators/swift4-deprecated.md +++ b/docs/generators/swift4-deprecated.md @@ -1,8 +1,16 @@ --- -title: Config Options for swift4-deprecated -sidebar_label: swift4-deprecated +title: Documentation for the swift4-deprecated Generator --- +## METADATA + +| Property | Value | Notes | +| -------- | ----- | ----- | +| generator name | swift4-deprecated | pass this to the generate command after -g | +| generator type | CLIENT | | +| helpTxt | Generates a Swift 4.x client library (Deprecated and will be removed in 5.x releases. Please use `swift5` instead.) | | + +## CONFIG OPTIONS These options may be applied 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/swift5.md b/docs/generators/swift5.md index 95f50fca7fc..cb5ea31e124 100644 --- a/docs/generators/swift5.md +++ b/docs/generators/swift5.md @@ -1,8 +1,16 @@ --- -title: Config Options for swift5 -sidebar_label: swift5 +title: Documentation for the swift5 Generator --- +## METADATA + +| Property | Value | Notes | +| -------- | ----- | ----- | +| generator name | swift5 | pass this to the generate command after -g | +| generator type | CLIENT | | +| helpTxt | Generates a Swift 5.x client library. | | + +## CONFIG OPTIONS These options may be applied 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/typescript-angular.md b/docs/generators/typescript-angular.md index 9421c54646e..accefab18e0 100644 --- a/docs/generators/typescript-angular.md +++ b/docs/generators/typescript-angular.md @@ -1,8 +1,16 @@ --- -title: Config Options for typescript-angular -sidebar_label: typescript-angular +title: Documentation for the typescript-angular Generator --- +## METADATA + +| Property | Value | Notes | +| -------- | ----- | ----- | +| generator name | typescript-angular | pass this to the generate command after -g | +| generator type | CLIENT | | +| helpTxt | Generates a TypeScript Angular (6.x - 13.x) client library. | | + +## CONFIG OPTIONS These options may be applied 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/typescript-angularjs-deprecated.md b/docs/generators/typescript-angularjs-deprecated.md index c094849a078..bcacd72ecb8 100644 --- a/docs/generators/typescript-angularjs-deprecated.md +++ b/docs/generators/typescript-angularjs-deprecated.md @@ -1,8 +1,16 @@ --- -title: Config Options for typescript-angularjs-deprecated -sidebar_label: typescript-angularjs-deprecated +title: Documentation for the typescript-angularjs-deprecated Generator --- +## METADATA + +| Property | Value | Notes | +| -------- | ----- | ----- | +| generator name | typescript-angularjs-deprecated | pass this to the generate command after -g | +| generator type | CLIENT | | +| helpTxt | Generates a TypeScript AngularJS client library. This generator has been deprecated and will be removed in the future release. | | + +## CONFIG OPTIONS These options may be applied 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/typescript-aurelia.md b/docs/generators/typescript-aurelia.md index 23b71ae41a3..0632ee05eb0 100644 --- a/docs/generators/typescript-aurelia.md +++ b/docs/generators/typescript-aurelia.md @@ -1,8 +1,16 @@ --- -title: Config Options for typescript-aurelia -sidebar_label: typescript-aurelia +title: Documentation for the typescript-aurelia Generator --- +## METADATA + +| Property | Value | Notes | +| -------- | ----- | ----- | +| generator name | typescript-aurelia | pass this to the generate command after -g | +| generator type | CLIENT | | +| helpTxt | Generates a TypeScript client library for the Aurelia framework (beta). | | + +## CONFIG OPTIONS These options may be applied 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/typescript-axios.md b/docs/generators/typescript-axios.md index d489756bacb..00bd32f9535 100644 --- a/docs/generators/typescript-axios.md +++ b/docs/generators/typescript-axios.md @@ -1,8 +1,16 @@ --- -title: Config Options for typescript-axios -sidebar_label: typescript-axios +title: Documentation for the typescript-axios Generator --- +## METADATA + +| Property | Value | Notes | +| -------- | ----- | ----- | +| generator name | typescript-axios | pass this to the generate command after -g | +| generator type | CLIENT | | +| helpTxt | Generates a TypeScript client library using axios. | | + +## CONFIG OPTIONS These options may be applied 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/typescript-fetch.md b/docs/generators/typescript-fetch.md index 3fe83380da4..b272b0bb2bf 100644 --- a/docs/generators/typescript-fetch.md +++ b/docs/generators/typescript-fetch.md @@ -1,8 +1,16 @@ --- -title: Config Options for typescript-fetch -sidebar_label: typescript-fetch +title: Documentation for the typescript-fetch Generator --- +## METADATA + +| Property | Value | Notes | +| -------- | ----- | ----- | +| generator name | typescript-fetch | pass this to the generate command after -g | +| generator type | CLIENT | | +| helpTxt | Generates a TypeScript client library using Fetch API (beta). | | + +## CONFIG OPTIONS These options may be applied 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/typescript-inversify.md b/docs/generators/typescript-inversify.md index 21e44eac43f..5834880e4a4 100644 --- a/docs/generators/typescript-inversify.md +++ b/docs/generators/typescript-inversify.md @@ -1,8 +1,16 @@ --- -title: Config Options for typescript-inversify -sidebar_label: typescript-inversify +title: Documentation for the typescript-inversify Generator --- +## METADATA + +| Property | Value | Notes | +| -------- | ----- | ----- | +| generator name | typescript-inversify | pass this to the generate command after -g | +| generator type | CLIENT | | +| helpTxt | Generates Typescript services using Inversify IOC | | + +## CONFIG OPTIONS These options may be applied 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/typescript-jquery.md b/docs/generators/typescript-jquery.md index 030fdd2e572..e9469f20589 100644 --- a/docs/generators/typescript-jquery.md +++ b/docs/generators/typescript-jquery.md @@ -1,8 +1,16 @@ --- -title: Config Options for typescript-jquery -sidebar_label: typescript-jquery +title: Documentation for the typescript-jquery Generator --- +## METADATA + +| Property | Value | Notes | +| -------- | ----- | ----- | +| generator name | typescript-jquery | pass this to the generate command after -g | +| generator type | CLIENT | | +| helpTxt | Generates a TypeScript jquery client library. | | + +## CONFIG OPTIONS These options may be applied 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/typescript-nestjs.md b/docs/generators/typescript-nestjs.md index a3f0b52a05d..0619d801227 100644 --- a/docs/generators/typescript-nestjs.md +++ b/docs/generators/typescript-nestjs.md @@ -1,8 +1,16 @@ --- -title: Config Options for typescript-nestjs -sidebar_label: typescript-nestjs +title: Documentation for the typescript-nestjs Generator --- +## METADATA + +| Property | Value | Notes | +| -------- | ----- | ----- | +| generator name | typescript-nestjs | pass this to the generate command after -g | +| generator type | CLIENT | | +| helpTxt | Generates a TypeScript Nestjs 6.x client library. | | + +## CONFIG OPTIONS These options may be applied 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/typescript-node.md b/docs/generators/typescript-node.md index 5de27045312..b2afd57352d 100644 --- a/docs/generators/typescript-node.md +++ b/docs/generators/typescript-node.md @@ -1,8 +1,16 @@ --- -title: Config Options for typescript-node -sidebar_label: typescript-node +title: Documentation for the typescript-node Generator --- +## METADATA + +| Property | Value | Notes | +| -------- | ----- | ----- | +| generator name | typescript-node | pass this to the generate command after -g | +| generator type | CLIENT | | +| helpTxt | Generates a TypeScript NodeJS client library. | | + +## CONFIG OPTIONS These options may be applied 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/typescript-redux-query.md b/docs/generators/typescript-redux-query.md index f2266c09703..022f22d8c5e 100644 --- a/docs/generators/typescript-redux-query.md +++ b/docs/generators/typescript-redux-query.md @@ -1,8 +1,16 @@ --- -title: Config Options for typescript-redux-query -sidebar_label: typescript-redux-query +title: Documentation for the typescript-redux-query Generator --- +## METADATA + +| Property | Value | Notes | +| -------- | ----- | ----- | +| generator name | typescript-redux-query | pass this to the generate command after -g | +| generator type | CLIENT | | +| helpTxt | Generates a TypeScript client library using redux-query API (beta). | | + +## CONFIG OPTIONS These options may be applied 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/typescript-rxjs.md b/docs/generators/typescript-rxjs.md index 40921ae7f58..52ed0e12ef0 100644 --- a/docs/generators/typescript-rxjs.md +++ b/docs/generators/typescript-rxjs.md @@ -1,8 +1,16 @@ --- -title: Config Options for typescript-rxjs -sidebar_label: typescript-rxjs +title: Documentation for the typescript-rxjs Generator --- +## METADATA + +| Property | Value | Notes | +| -------- | ----- | ----- | +| generator name | typescript-rxjs | pass this to the generate command after -g | +| generator type | CLIENT | | +| helpTxt | Generates a TypeScript client library using Rxjs API. | | + +## CONFIG OPTIONS These options may be applied 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/typescript.md b/docs/generators/typescript.md index 9c6eea23c03..3aae708a3bd 100644 --- a/docs/generators/typescript.md +++ b/docs/generators/typescript.md @@ -1,8 +1,16 @@ --- -title: Config Options for typescript -sidebar_label: typescript +title: Documentation for the typescript Generator --- +## METADATA + +| Property | Value | Notes | +| -------- | ----- | ----- | +| generator name | typescript | pass this to the generate command after -g | +| generator type | CLIENT | | +| helpTxt | Generates a TypeScript client library using Fetch API (beta). | | + +## CONFIG OPTIONS These options may be applied 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/wsdl-schema.md b/docs/generators/wsdl-schema.md index a2af1139862..47c95920be5 100644 --- a/docs/generators/wsdl-schema.md +++ b/docs/generators/wsdl-schema.md @@ -1,8 +1,16 @@ --- -title: Config Options for wsdl-schema -sidebar_label: wsdl-schema +title: Documentation for the wsdl-schema Generator --- +## METADATA + +| Property | Value | Notes | +| -------- | ----- | ----- | +| generator name | wsdl-schema | pass this to the generate command after -g | +| generator type | SCHEMA | | +| helpTxt | Generates WSDL files. | | + +## CONFIG OPTIONS These options may be applied 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/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 8193e20e3f4..3c61526cddc 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 @@ -70,6 +70,9 @@ public class ConfigHelp extends OpenApiGeneratorCommand { @Option(name = {"--import-mappings"}, title = "import mappings", description = "displays the default import mappings (types and aliases, and what imports they will pull into the template)") private Boolean importMappings; + @Option(name = {"--metadata"}, title = "metadata", description = "displays the generator metadata like the help txt for the generator and generator type etc") + private Boolean metadata; + @Option(name = {"--language-specific-primitive"}, title = "language specific primitives", description = "displays the language specific primitives (types which require no additional imports, or which may conflict with user defined model names)") private Boolean languageSpecificPrimitives; @@ -104,6 +107,7 @@ public class ConfigHelp extends OpenApiGeneratorCommand { languageSpecificPrimitives = Boolean.TRUE; importMappings = Boolean.TRUE; featureSets = Boolean.TRUE; + metadata = Boolean.TRUE; } try { @@ -153,26 +157,8 @@ public class ConfigHelp extends OpenApiGeneratorCommand { } } - private void generateMarkdownHelp(StringBuilder sb, CodegenConfig config) { - if (Boolean.TRUE.equals(markdownHeader)) { - sb.append("---").append(newline); - 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"); - - if (Boolean.TRUE.equals(namedHeader)) { - sb.append(" for ").append(generatorName).append("").append(newline); - } - } - + private void generateMdConfigOptions(StringBuilder sb, CodegenConfig config) { sb.append(newline); - sb.append("| Option | Description | Values | Default |").append(newline); sb.append("| ------ | ----------- | ------ | ------- |").append(newline); @@ -210,90 +196,152 @@ public class ConfigHelp extends OpenApiGeneratorCommand { // default sb.append(escapeHtml4(langCliOption.getDefault())).append("|").append(newline); }); + } + private void generateMdImportMappings(StringBuilder sb, CodegenConfig config) { + sb.append(newline).append("## IMPORT MAPPING").append(newline).append(newline); + + sb.append("| Type/Alias | Imports |").append(newline); + sb.append("| ---------- | ------- |").append(newline); + + config.importMapping() + .entrySet() + .stream() + .sorted(Map.Entry.comparingByKey()) + .forEachOrdered(kvp -> { + sb.append("|").append(escapeHtml4(kvp.getKey())).append("|").append(escapeHtml4(kvp.getValue())).append("|"); + sb.append(newline); + }); + + sb.append(newline); + } + + private void generateMdInstantiationTypes(StringBuilder sb, CodegenConfig config) { + sb.append(newline).append("## INSTANTIATION TYPES").append(newline).append(newline); + + sb.append("| Type/Alias | Instantiated By |").append(newline); + sb.append("| ---------- | --------------- |").append(newline); + + config.instantiationTypes() + .entrySet() + .stream() + .sorted(Map.Entry.comparingByKey()) + .forEachOrdered(kvp -> { + sb.append("|").append(escapeHtml4(kvp.getKey())).append("|").append(escapeHtml4(kvp.getValue())).append("|"); + sb.append(newline); + }); + + sb.append(newline); + } + + private void generateMdLanguageSpecificPrimitives(StringBuilder sb, CodegenConfig config) { + sb.append(newline).append("## LANGUAGE PRIMITIVES").append(newline).append(newline); + + sb.append("").append(newline); + } + + private void generateMdReservedWords(StringBuilder sb, CodegenConfig config) { + sb.append(newline).append("## RESERVED WORDS").append(newline).append(newline); + + sb.append("").append(newline); + } + + private void generateMdFeatureSets(StringBuilder sb, CodegenConfig config) { + sb.append(newline).append("## FEATURE SET").append(newline).append(newline); + + List flattened = config.getGeneratorMetadata().getFeatureSet().flatten(); + flattened.sort(Comparator.comparing(FeatureSet.FeatureSetFlattened::getFeatureCategory)); + + AtomicReference lastCategory = new AtomicReference<>(); + flattened.forEach(featureSet -> { + if (!featureSet.getFeatureCategory().equals(lastCategory.get())) { + lastCategory.set(featureSet.getFeatureCategory()); + + String[] header = StringUtils.splitByCharacterTypeCamelCase(featureSet.getFeatureCategory()); + sb.append(newline).append("### ").append(StringUtils.join(header, " ")).append(newline); + + sb.append("| Name | Supported | Defined By |").append(newline); + sb.append("| ---- | --------- | ---------- |").append(newline); + } + + // Appends a ✓ or ✗ for support + sb.append("|").append(featureSet.getFeatureName()) + .append("|").append(featureSet.isSupported() ? "✓" : "✗") + .append("|").append(StringUtils.join(featureSet.getSource(), ",")) + .append(newline); + }); + } + + private void generateMdConfigOptionsHeader(StringBuilder sb, CodegenConfig config) { + if (Boolean.TRUE.equals(markdownHeader)) { + sb.append("## CONFIG OPTIONS").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"); + + if (Boolean.TRUE.equals(namedHeader)) { + sb.append(" for ").append(generatorName).append("").append(newline); + } + } + } + + private void generateMdMetadata(StringBuilder sb, CodegenConfig config) { + sb.append("## METADATA").append(newline).append(newline); + + sb.append("| Property | Value | Notes |").append(newline); + sb.append("| -------- | ----- | ----- |").append(newline); + sb.append("| generator name | "+config.getName()+" | pass this to the generate command after -g |").append(newline); + sb.append("| generator type | "+config.getTag()+" | |").append(newline); + sb.append("| helpTxt | "+config.getHelp()+" | |").append(newline); + + sb.append(newline); + } + + private void generateMarkdownHelp(StringBuilder sb, CodegenConfig config) { + if (Boolean.TRUE.equals(markdownHeader)) { + sb.append("---").append(newline); + sb.append("title: Documentation for the " + generatorName + " Generator").append(newline); + sb.append("---").append(newline); + sb.append(newline); + } + + if (Boolean.TRUE.equals(metadata)) { + generateMdMetadata(sb, config); + } + + generateMdConfigOptionsHeader(sb, config); + generateMdConfigOptions(sb, config); if (Boolean.TRUE.equals(importMappings)) { - sb.append(newline).append("## IMPORT MAPPING").append(newline).append(newline); - - sb.append("| Type/Alias | Imports |").append(newline); - sb.append("| ---------- | ------- |").append(newline); - - config.importMapping() - .entrySet() - .stream() - .sorted(Map.Entry.comparingByKey()) - .forEachOrdered(kvp -> { - sb.append("|").append(escapeHtml4(kvp.getKey())).append("|").append(escapeHtml4(kvp.getValue())).append("|"); - sb.append(newline); - }); - - sb.append(newline); + generateMdImportMappings(sb, config); } if (Boolean.TRUE.equals(instantiationTypes)) { - sb.append(newline).append("## INSTANTIATION TYPES").append(newline).append(newline); - - sb.append("| Type/Alias | Instantiated By |").append(newline); - sb.append("| ---------- | --------------- |").append(newline); - - config.instantiationTypes() - .entrySet() - .stream() - .sorted(Map.Entry.comparingByKey()) - .forEachOrdered(kvp -> { - sb.append("|").append(escapeHtml4(kvp.getKey())).append("|").append(escapeHtml4(kvp.getValue())).append("|"); - sb.append(newline); - }); - - sb.append(newline); + generateMdInstantiationTypes(sb, config); } if (Boolean.TRUE.equals(languageSpecificPrimitives)) { - sb.append(newline).append("## LANGUAGE PRIMITIVES").append(newline).append(newline); - - sb.append("
    ").append(newline); - config.languageSpecificPrimitives() - .stream() - .sorted(String::compareTo) - .forEach(s -> sb.append("
  • ").append(escapeHtml4(s)).append("
    • ").append(newline)); - sb.append("
").append(newline); + generateMdLanguageSpecificPrimitives(sb, config); } if (Boolean.TRUE.equals(reservedWords)) { - sb.append(newline).append("## RESERVED WORDS").append(newline).append(newline); - - sb.append("
    ").append(newline); - config.reservedWords() - .stream() - .sorted(String::compareTo) - .forEach(s -> sb.append("
  • ").append(escapeHtml4(s)).append("
    • ").append(newline)); - sb.append("
").append(newline); + generateMdReservedWords(sb, config); } if (Boolean.TRUE.equals(featureSets)) { - sb.append(newline).append("## FEATURE SET").append(newline).append(newline); - - List flattened = config.getGeneratorMetadata().getFeatureSet().flatten(); - flattened.sort(Comparator.comparing(FeatureSet.FeatureSetFlattened::getFeatureCategory)); - - AtomicReference lastCategory = new AtomicReference<>(); - flattened.forEach(featureSet -> { - if (!featureSet.getFeatureCategory().equals(lastCategory.get())) { - lastCategory.set(featureSet.getFeatureCategory()); - - String[] header = StringUtils.splitByCharacterTypeCamelCase(featureSet.getFeatureCategory()); - sb.append(newline).append("### ").append(StringUtils.join(header, " ")).append(newline); - - sb.append("| Name | Supported | Defined By |").append(newline); - sb.append("| ---- | --------- | ---------- |").append(newline); - } - - // Appends a ✓ or ✗ for support - sb.append("|").append(featureSet.getFeatureName()) - .append("|").append(featureSet.isSupported() ? "✓" : "✗") - .append("|").append(StringUtils.join(featureSet.getSource(), ",")) - .append(newline); - }); + generateMdFeatureSets(sb, config); } } diff --git a/modules/openapi-generator/src/main/java/org/openapitools/codegen/languages/PythonExperimentalClientCodegen.java b/modules/openapi-generator/src/main/java/org/openapitools/codegen/languages/PythonExperimentalClientCodegen.java index 187ae357e02..cc985490ae9 100644 --- a/modules/openapi-generator/src/main/java/org/openapitools/codegen/languages/PythonExperimentalClientCodegen.java +++ b/modules/openapi-generator/src/main/java/org/openapitools/codegen/languages/PythonExperimentalClientCodegen.java @@ -499,7 +499,7 @@ public class PythonExperimentalClientCodegen extends AbstractPythonCodegen { @Override public String getHelp() { String newLine = System.getProperty("line.separator"); - return String.join(newLine, + return String.join("
", "Generates a Python client library", "", "Features in this generator:",