From 644f720db8d1c6accdbfc9de4641c142baa0e2f6 Mon Sep 17 00:00:00 2001 From: Jim Schubert Date: Sun, 19 Jan 2020 20:19:11 -0500 Subject: [PATCH] [docs] Sorted doc outputs and clean up duplicated CliOptions (#5046) * [config-help] Sort all outputs * Remove old/stale generator docs (these have been renamed previously) * Sort config doc outputs, making it easier to find relevant info * Fixes cliOptions duplicates Erlang client/proper improperly set the version option as packageName (causing duplicate for packageName). The java and swift option removals are because the options are added in parent classes, resulting in duplication of the options. * Add --github-nested-index for generating docs/generators/README.md * :memo: Regenerate generator docs --- docs/generators/README.md | 235 ++++---- docs/generators/ada-server.md | 148 ++--- docs/generators/ada.md | 148 ++--- docs/generators/android.md | 178 +++--- docs/generators/apache2.md | 26 +- docs/generators/apex.md | 282 ++++----- docs/generators/asciidoc.md | 26 +- docs/generators/aspnetcore.md | 300 +++++----- docs/generators/avro-schema.md | 26 +- docs/generators/bash.md | 68 +-- docs/generators/c.md | 100 ++-- docs/generators/clojure.md | 34 +- docs/generators/cpp-pistache-server.md | 10 +- docs/generators/cpp-qt5-client.md | 188 +++--- docs/generators/cpp-qt5-qhttpengine-server.md | 188 +++--- docs/generators/cpp-restbed-server.md | 182 +++--- docs/generators/cpp-restsdk.md | 184 +++--- docs/generators/cpp-tizen.md | 186 +++--- docs/generators/csharp-dotnet2.md | 242 ++++---- docs/generators/csharp-nancyfx.md | 88 +-- docs/generators/csharp-netcore.md | 272 ++++----- docs/generators/csharp-refactor.md | 29 - docs/generators/csharp.md | 276 ++++----- docs/generators/cwiki.md | 22 +- docs/generators/dart-dio.md | 154 ++--- docs/generators/dart-jaguar.md | 152 ++--- docs/generators/dart.md | 148 ++--- docs/generators/dynamic-html.md | 12 +- docs/generators/eiffel.md | 142 ++--- docs/generators/elixir.md | 46 +- docs/generators/elm.md | 28 +- docs/generators/erlang-client.md | 70 +-- docs/generators/erlang-proper.md | 70 +-- docs/generators/erlang-server.md | 70 +-- docs/generators/flash.md | 56 +- docs/generators/fsharp-functions.md | 278 ++++----- docs/generators/fsharp-giraffe-server.md | 290 +++++----- docs/generators/fsharp-giraffe.md | 25 - docs/generators/go-experimental.md | 100 ++-- docs/generators/go-gin-server.md | 90 +-- docs/generators/go-server.md | 94 +-- docs/generators/go.md | 100 ++-- .../graphql-nodejs-express-server.md | 48 +- docs/generators/graphql-schema.md | 48 +- docs/generators/graphql-server.md | 12 - docs/generators/groovy.md | 210 +++---- docs/generators/grpc-schema.md | 9 - docs/generators/haskell-http-client.md | 112 ++-- docs/generators/haskell.md | 74 +-- docs/generators/html.md | 22 +- docs/generators/html2.md | 30 +- docs/generators/java-inflector.md | 208 +++---- docs/generators/java-msf4j.md | 214 +++---- docs/generators/java-pkmst.md | 220 +++---- docs/generators/java-play-framework.md | 218 +++---- docs/generators/java-undertow-server.md | 208 +++---- docs/generators/java-vertx-web.md | 208 +++---- docs/generators/java-vertx.md | 212 +++---- docs/generators/java.md | 230 ++++---- docs/generators/javascript-closure-angular.md | 96 ++-- docs/generators/javascript-flowtyped.md | 174 +++--- docs/generators/javascript.md | 174 +++--- docs/generators/jaxrs-cxf-cdi.md | 223 ++++--- docs/generators/jaxrs-cxf-client.md | 210 +++---- docs/generators/jaxrs-cxf-extended.md | 252 ++++---- docs/generators/jaxrs-cxf.md | 242 ++++---- docs/generators/jaxrs-jersey.md | 216 +++---- docs/generators/jaxrs-resteasy-eap.md | 215 ++++--- docs/generators/jaxrs-resteasy.md | 214 +++---- docs/generators/jaxrs-spec.md | 222 +++---- docs/generators/jmeter.md | 26 +- docs/generators/kotlin-server.md | 100 ++-- docs/generators/kotlin-spring.md | 124 ++-- docs/generators/kotlin-vertx.md | 88 +-- docs/generators/kotlin.md | 98 ++-- docs/generators/lua.md | 48 +- docs/generators/markdown.md | 26 +- docs/generators/mysql-schema.md | 542 +++++++++--------- docs/generators/nim.md | 170 +++--- docs/generators/nodejs-express-server.md | 82 +-- docs/generators/nodejs-server-deprecated.md | 86 +-- docs/generators/nodejs-server.md | 16 - docs/generators/objc.md | 128 ++--- docs/generators/ocaml-client.md | 13 - docs/generators/ocaml.md | 138 ++--- docs/generators/openapi-yaml.md | 28 +- docs/generators/openapi.md | 26 +- docs/generators/perl.md | 76 +-- docs/generators/php-laravel.md | 164 +++--- docs/generators/php-lumen.md | 164 +++--- docs/generators/php-silex.md | 134 ++--- docs/generators/php-slim-deprecated.md | 144 ++--- docs/generators/php-slim.md | 18 - docs/generators/php-slim4.md | 144 ++--- docs/generators/php-symfony.md | 146 ++--- docs/generators/php-ze-ph.md | 164 +++--- docs/generators/php.md | 144 ++--- docs/generators/powershell.md | 108 ++-- docs/generators/protobuf-schema.md | 26 +- docs/generators/python-aiohttp.md | 100 ++-- docs/generators/python-blueplanet.md | 100 ++-- docs/generators/python-experimental.md | 98 ++-- docs/generators/python-flask.md | 100 ++-- docs/generators/python.md | 94 +-- docs/generators/r.md | 40 +- docs/generators/ruby-on-rails.md | 96 ++-- docs/generators/ruby-sinatra.md | 96 ++-- docs/generators/ruby.md | 122 ++-- docs/generators/rust-server.md | 102 ++-- docs/generators/rust.md | 128 ++--- docs/generators/scala-akka.md | 114 ++-- docs/generators/scala-finch.md | 150 ++--- docs/generators/scala-gatling.md | 128 ++--- .../generators/scala-httpclient-deprecated.md | 130 ++--- docs/generators/scala-httpclient.md | 17 - docs/generators/scala-lagom-server.md | 130 ++--- docs/generators/scala-play-framework.md | 22 - docs/generators/scala-play-server.md | 128 ++--- docs/generators/scalatra.md | 136 ++--- docs/generators/scalaz.md | 130 ++--- docs/generators/spring.md | 246 ++++---- docs/generators/swift2-deprecated.md | 220 +++---- docs/generators/swift3-deprecated.md | 204 +++---- docs/generators/swift4.md | 323 ++++++----- docs/generators/swift5.md | 323 ++++++----- docs/generators/typescript-angular.md | 182 +++--- docs/generators/typescript-angularjs.md | 150 ++--- docs/generators/typescript-aurelia.md | 152 ++--- docs/generators/typescript-axios.md | 156 ++--- docs/generators/typescript-fetch.md | 214 +++---- docs/generators/typescript-inversify.md | 164 +++--- docs/generators/typescript-jquery.md | 162 +++--- docs/generators/typescript-node.md | 164 +++--- docs/generators/typescript-redux-query.md | 208 +++---- docs/generators/typescript-rxjs.md | 194 +++---- .../openapitools/codegen/cmd/ConfigHelp.java | 77 ++- .../codegen/cmd/ListGenerators.java | 10 +- .../languages/ErlangClientCodegen.java | 2 +- .../languages/ErlangProperCodegen.java | 2 +- .../JavaJAXRSCXFCDIServerCodegen.java | 2 - .../JavaResteasyEapServerCodegen.java | 1 - .../codegen/languages/Swift4Codegen.java | 2 - .../languages/Swift5ClientCodegen.java | 2 - 143 files changed, 9131 insertions(+), 9245 deletions(-) delete mode 100644 docs/generators/csharp-refactor.md delete mode 100644 docs/generators/fsharp-giraffe.md delete mode 100644 docs/generators/graphql-server.md delete mode 100644 docs/generators/grpc-schema.md delete mode 100644 docs/generators/nodejs-server.md delete mode 100644 docs/generators/ocaml-client.md delete mode 100644 docs/generators/php-slim.md delete mode 100644 docs/generators/scala-httpclient.md delete mode 100644 docs/generators/scala-play-framework.md diff --git a/docs/generators/README.md b/docs/generators/README.md index 070ef96c15e..cd9e5f551c7 100644 --- a/docs/generators/README.md +++ b/docs/generators/README.md @@ -1,123 +1,138 @@ + The following generators are available: -* CLIENT generators: - - [ada](ada.md) - - [android](android.md) - - [apex](apex.md) - - [bash](bash.md) - - [c](c.md) - - [clojure](clojure.md) - - [cpp-qt5-client](cpp-qt5-client.md) - - [cpp-restsdk](cpp-restsdk.md) - - [cpp-tizen](cpp-tizen.md) - - [csharp](csharp.md) - - [csharp-dotnet2](csharp-dotnet2.md) - - [csharp-refactor](csharp-refactor.md) - - [dart](dart.md) - - [dart-dio](dart-dio.md) - - [dart-jaguar](dart-jaguar.md) - - [eiffel](eiffel.md) - - [elixir](elixir.md) - - [elm](elm.md) - - [erlang-client](erlang-client.md) - - [erlang-proper](erlang-proper.md) - - [flash](flash.md) - - [go](go.md) - - [groovy](groovy.md) - - [haskell-http-client](haskell-http-client.md) - - [java](java.md) - - [javascript](javascript.md) - - [javascript-closure-angular](javascript-closure-angular.md) - - [javascript-flowtyped](javascript-flowtyped.md) - - [jaxrs-cxf-client](jaxrs-cxf-client.md) - - [jmeter](jmeter.md) - - [kotlin](kotlin.md) - - [lua](lua.md) - - [objc](objc.md) - - [perl](perl.md) - - [php](php.md) - - [powershell](powershell.md) - - [python](python.md) - - [r](r.md) - - [ruby](ruby.md) - - [rust](rust.md) - - [scala-akka](scala-akka.md) - - [scala-gatling](scala-gatling.md) - - [scala-httpclient](scala-httpclient.md) - - [scalaz](scalaz.md) - - [swift2-deprecated](swift2-deprecated.md) - - [swift3-deprecated](swift3-deprecated.md) - - [swift4](swift4.md) - - [typescript-angular](typescript-angular.md) - - [typescript-angularjs](typescript-angularjs.md) - - [typescript-aurelia](typescript-aurelia.md) - - [typescript-axios](typescript-axios.md) - - [typescript-fetch](typescript-fetch.md) - - [typescript-inversify](typescript-inversify.md) - - [typescript-jquery](typescript-jquery.md) - - [typescript-node](typescript-node.md) - - [typescript-rxjs](typescript-rxjs.md) +## CLIENT generators +* [ada](ada.md) +* [android](android.md) +* [apex](apex.md) +* [bash](bash.md) +* [c](c.md) +* [clojure](clojure.md) +* [cpp-qt5-client](cpp-qt5-client.md) +* [cpp-restsdk](cpp-restsdk.md) +* [cpp-tizen](cpp-tizen.md) +* [csharp](csharp.md) +* [csharp-netcore](csharp-netcore.md) +* [dart](dart.md) +* [dart-dio](dart-dio.md) +* [dart-jaguar](dart-jaguar.md) +* [eiffel](eiffel.md) +* [elixir](elixir.md) +* [elm](elm.md) +* [erlang-client](erlang-client.md) +* [erlang-proper](erlang-proper.md) +* [flash](flash.md) +* [go](go.md) +* [go-experimental (experimental)](go-experimental.md) +* [groovy](groovy.md) +* [haskell-http-client](haskell-http-client.md) +* [java](java.md) +* [javascript](javascript.md) +* [javascript-closure-angular](javascript-closure-angular.md) +* [javascript-flowtyped](javascript-flowtyped.md) +* [jaxrs-cxf-client](jaxrs-cxf-client.md) +* [jmeter](jmeter.md) +* [kotlin](kotlin.md) +* [lua](lua.md) +* [nim (beta)](nim.md) +* [objc](objc.md) +* [ocaml](ocaml.md) +* [perl](perl.md) +* [php](php.md) +* [powershell](powershell.md) +* [python](python.md) +* [python-experimental (experimental)](python-experimental.md) +* [r](r.md) +* [ruby](ruby.md) +* [rust](rust.md) +* [scala-akka](scala-akka.md) +* [scala-gatling](scala-gatling.md) +* [scalaz](scalaz.md) +* [swift4](swift4.md) +* [swift5 (beta)](swift5.md) +* [typescript-angular](typescript-angular.md) +* [typescript-angularjs](typescript-angularjs.md) +* [typescript-aurelia](typescript-aurelia.md) +* [typescript-axios](typescript-axios.md) +* [typescript-fetch](typescript-fetch.md) +* [typescript-inversify](typescript-inversify.md) +* [typescript-jquery](typescript-jquery.md) +* [typescript-node](typescript-node.md) +* [typescript-redux-query](typescript-redux-query.md) +* [typescript-rxjs](typescript-rxjs.md) -* SERVER generators: - - [ada-server](ada-server.md) - - [aspnetcore](aspnetcore.md) - - [cpp-pistache-server](cpp-pistache-server.md) - - [cpp-qt5-qhttpengine-server](cpp-qt5-qhttpengine-server.md) - - [cpp-restbed-server](cpp-restbed-server.md) - - [csharp-nancyfx](csharp-nancyfx.md) - - [erlang-server](erlang-server.md) - - [go-gin-server](go-gin-server.md) - - [go-server](go-server.md) - - [graphql-server](graphql-server.md) - - [haskell](haskell.md) - - [java-inflector](java-inflector.md) - - [java-msf4j](java-msf4j.md) - - [java-pkmst](java-pkmst.md) - - [java-play-framework](java-play-framework.md) - - [java-undertow-server](java-undertow-server.md) - - [java-vertx](java-vertx.md) - - [jaxrs-cxf](jaxrs-cxf.md) - - [jaxrs-cxf-cdi](jaxrs-cxf-cdi.md) - - [jaxrs-jersey](jaxrs-jersey.md) - - [jaxrs-resteasy](jaxrs-resteasy.md) - - [jaxrs-resteasy-eap](jaxrs-resteasy-eap.md) - - [jaxrs-spec](jaxrs-spec.md) - - [kotlin-server](kotlin-server.md) - - [kotlin-spring](kotlin-spring.md) - - [nodejs-server](nodejs-server.md) - - [php-laravel](php-laravel.md) - - [php-lumen](php-lumen.md) - - [php-silex](php-silex.md) - - [php-slim](php-slim.md) - - [php-symfony](php-symfony.md) - - [php-ze-ph](php-ze-ph.md) - - [python-flask](python-flask.md) - - [ruby-on-rails](ruby-on-rails.md) - - [ruby-sinatra](ruby-sinatra.md) - - [rust-server](rust-server.md) - - [scala-finch](scala-finch.md) - - [scala-lagom-server](scala-lagom-server.md) - - [scalatra](scalatra.md) - - [spring](spring.md) +## SERVER generators +* [ada-server](ada-server.md) +* [aspnetcore](aspnetcore.md) +* [cpp-pistache-server](cpp-pistache-server.md) +* [cpp-qt5-qhttpengine-server](cpp-qt5-qhttpengine-server.md) +* [cpp-restbed-server](cpp-restbed-server.md) +* [csharp-nancyfx](csharp-nancyfx.md) +* [erlang-server](erlang-server.md) +* [fsharp-functions (beta)](fsharp-functions.md) +* [fsharp-giraffe-server (beta)](fsharp-giraffe-server.md) +* [go-gin-server](go-gin-server.md) +* [go-server](go-server.md) +* [graphql-nodejs-express-server](graphql-nodejs-express-server.md) +* [haskell](haskell.md) +* [java-inflector](java-inflector.md) +* [java-msf4j](java-msf4j.md) +* [java-pkmst](java-pkmst.md) +* [java-play-framework](java-play-framework.md) +* [java-undertow-server](java-undertow-server.md) +* [java-vertx](java-vertx.md) +* [java-vertx-web (beta)](java-vertx-web.md) +* [jaxrs-cxf](jaxrs-cxf.md) +* [jaxrs-cxf-cdi](jaxrs-cxf-cdi.md) +* [jaxrs-cxf-extended](jaxrs-cxf-extended.md) +* [jaxrs-jersey](jaxrs-jersey.md) +* [jaxrs-resteasy](jaxrs-resteasy.md) +* [jaxrs-resteasy-eap](jaxrs-resteasy-eap.md) +* [jaxrs-spec](jaxrs-spec.md) +* [kotlin-server](kotlin-server.md) +* [kotlin-spring](kotlin-spring.md) +* [kotlin-vertx (beta)](kotlin-vertx.md) +* [nodejs-express-server (beta)](nodejs-express-server.md) +* [php-laravel](php-laravel.md) +* [php-lumen](php-lumen.md) +* [php-silex](php-silex.md) +* [php-slim4](php-slim4.md) +* [php-symfony](php-symfony.md) +* [php-ze-ph](php-ze-ph.md) +* [python-aiohttp](python-aiohttp.md) +* [python-blueplanet](python-blueplanet.md) +* [python-flask](python-flask.md) +* [ruby-on-rails](ruby-on-rails.md) +* [ruby-sinatra](ruby-sinatra.md) +* [rust-server](rust-server.md) +* [scala-finch](scala-finch.md) +* [scala-lagom-server](scala-lagom-server.md) +* [scala-play-server](scala-play-server.md) +* [scalatra](scalatra.md) +* [spring](spring.md) -* DOCUMENTATION generators: - - [cwiki](cwiki.md) - - [dynamic-html](dynamic-html.md) - - [html](html.md) - - [html2](html2.md) - - [openapi](openapi.md) - - [openapi-yaml](openapi-yaml.md) +## DOCUMENTATION generators +* [asciidoc](asciidoc.md) +* [cwiki](cwiki.md) +* [dynamic-html](dynamic-html.md) +* [html](html.md) +* [html2](html2.md) +* [markdown (beta)](markdown.md) +* [openapi](openapi.md) +* [openapi-yaml](openapi-yaml.md) -* SCHEMA generators: - - [mysql-schema](mysql-schema.md) +## SCHEMA generators +* [avro-schema (beta)](avro-schema.md) +* [mysql-schema](mysql-schema.md) -* CONFIG generators: - - [apache2](apache2.md) - - [graphql-schema](graphql-schema.md) +## CONFIG generators +* [apache2](apache2.md) +* [graphql-schema](graphql-schema.md) +* [protobuf-schema (beta)](protobuf-schema.md) diff --git a/docs/generators/ada-server.md b/docs/generators/ada-server.md index 174e3fca5f0..61f5b1c53e2 100644 --- a/docs/generators/ada-server.md +++ b/docs/generators/ada-server.md @@ -5,12 +5,12 @@ sidebar_label: ada-server | Option | Description | Values | Default | | ------ | ----------- | ------ | ------- | -|sortParamsByRequiredFlag|Sort method arguments to place required parameters before optional parameters.| |true| -|sortModelPropertiesByRequiredFlag|Sort model properties to place required parameters before optional parameters.| |true| -|ensureUniqueParams|Whether to ensure parameter names are unique in an operation (rename parameters that are not).| |true| |allowUnicodeIdentifiers|boolean, toggles whether unicode identifiers are allowed in names or not, default is false| |false| +|ensureUniqueParams|Whether to ensure parameter names are unique in an operation (rename parameters that are not).| |true| |prependFormOrBodyParameters|Add form or body parameters to the beginning of the parameter list.| |false| |projectName|GNAT project name| |defaultProject| +|sortModelPropertiesByRequiredFlag|Sort model properties to place required parameters before optional parameters.| |true| +|sortParamsByRequiredFlag|Sort method arguments to place required parameters before optional parameters.| |true| ## IMPORT MAPPING @@ -26,88 +26,88 @@ sidebar_label: ada-server ## LANGUAGE PRIMITIVES -