From 6aeb53424287b25d7ca45df3b797d8aa2b8e5a82 Mon Sep 17 00:00:00 2001 From: Jim Schubert Date: Fri, 28 Dec 2018 16:53:24 -0500 Subject: [PATCH 01/17] Iniital docusaurus based site --- README.md | 2 +- bin/utils/export_generator.sh | 4 +- .../export_generators_docusaurus_index.sh | 20 + bin/utils/export_generators_readme.sh | 14 +- docker-compose.yml | 18 + docs/3.0.0-release-note.md | 723 +- docs/conduct.md | 49 + docs/contributing.md | 106 + docs/core-team.md | 12 + docs/customization.md | 21 +- docs/faq.md | 22 + docs/generators.md | 126 + docs/generators/README.md | 9 +- docs/generators/ada-server.md | 31 +- docs/generators/ada.md | 31 +- docs/generators/android.md | 81 +- docs/generators/apache2.md | 31 +- docs/generators/apex.md | 43 +- docs/generators/aspnetcore.md | 51 +- docs/generators/bash.md | 59 +- docs/generators/c.md | 14 + docs/generators/clojure.md | 55 +- docs/generators/cpp-pistache-server.md | 19 +- docs/generators/cpp-qt5-client.md | 16 + docs/generators/cpp-qt5-qhttpengine-server.md | 35 +- docs/generators/cpp-qt5.md | 22 - docs/generators/cpp-restbed-server.md | 31 +- docs/generators/cpp-restsdk.md | 35 +- docs/generators/cpp-tizen.md | 27 +- docs/generators/csharp-dotnet2.md | 23 +- docs/generators/csharp-nancyfx.md | 67 +- docs/generators/csharp-refactor.md | 30 + docs/generators/csharp.md | 100 +- docs/generators/cwiki.md | 67 +- docs/generators/dart-jaguar.md | 59 +- docs/generators/dart.md | 55 +- docs/generators/dynamic-html.md | 43 +- docs/generators/eiffel.md | 23 +- docs/generators/elixir.md | 39 +- docs/generators/elm.md | 29 +- docs/generators/erlang-client.md | 19 +- docs/generators/erlang-proper.md | 11 + docs/generators/erlang-server.md | 19 +- docs/generators/flash.md | 27 +- docs/generators/go-gin-server.md | 19 +- docs/generators/go-server.md | 19 +- docs/generators/go.md | 35 +- docs/generators/graphql-schema.md | 12 + docs/generators/graphql-server.md | 12 + docs/generators/groovy.md | 162 +- docs/generators/haskell-http-client.md | 103 +- docs/generators/haskell.md | 35 +- docs/generators/html.md | 67 +- docs/generators/html2.md | 83 +- docs/generators/java-inflector.md | 158 +- docs/generators/java-msf4j.md | 180 +- docs/generators/java-pkmst.md | 198 +- docs/generators/java-play-framework.md | 194 +- docs/generators/java-undertow-server.md | 158 +- docs/generators/java-vertx.md | 166 +- docs/generators/java.md | 218 +- docs/generators/javascript-closure-angular.md | 35 +- docs/generators/javascript-flowtyped.md | 51 +- docs/generators/javascript.md | 95 +- docs/generators/jaxrs-cxf-cdi.md | 199 +- docs/generators/jaxrs-cxf-client.md | 174 +- docs/generators/jaxrs-cxf.md | 242 +- docs/generators/jaxrs-jersey.md | 188 +- docs/generators/jaxrs-resteasy-eap.md | 186 +- docs/generators/jaxrs-resteasy.md | 178 +- docs/generators/jaxrs-spec.md | 195 +- docs/generators/jmeter.md | 27 +- docs/generators/kotlin-server.md | 64 +- docs/generators/kotlin-spring.md | 88 +- docs/generators/kotlin.md | 52 +- docs/generators/lua.md | 23 +- docs/generators/mysql-schema.md | 19 +- docs/generators/nodejs-server.md | 39 +- docs/generators/objc.md | 43 +- docs/generators/openapi-yaml.md | 31 +- docs/generators/openapi.md | 27 +- docs/generators/perl.md | 35 +- docs/generators/php-laravel.md | 63 +- docs/generators/php-lumen.md | 63 +- docs/generators/php-silex.md | 27 +- docs/generators/php-slim.md | 67 +- docs/generators/php-symfony.md | 83 +- docs/generators/php-ze-ph.md | 63 +- docs/generators/php.md | 75 +- docs/generators/powershell.md | 23 +- docs/generators/python-flask.md | 51 +- docs/generators/python.md | 43 +- docs/generators/r.md | 23 +- docs/generators/ruby-on-rails.md | 13 +- docs/generators/ruby-sinatra.md | 9 +- docs/generators/ruby.md | 71 +- docs/generators/rust-server.md | 19 +- docs/generators/rust.md | 29 +- docs/generators/scala-akka.md | 43 +- docs/generators/scala-finch.md | 23 +- docs/generators/scala-gatling.md | 39 +- docs/generators/scala-httpclient.md | 43 +- docs/generators/scala-lagom-server.md | 43 +- docs/generators/scalatra.md | 39 +- docs/generators/scalaz.md | 43 +- docs/generators/spring.md | 245 +- docs/generators/swift2-deprecated.md | 91 +- docs/generators/swift3-deprecated.md | 31 + docs/generators/swift3.md | 70 - docs/generators/swift4.md | 99 +- docs/generators/typescript-angular.md | 87 +- docs/generators/typescript-angularjs.md | 35 +- docs/generators/typescript-aurelia.md | 43 +- docs/generators/typescript-axios.md | 55 +- docs/generators/typescript-fetch.md | 55 +- docs/generators/typescript-inversify.md | 63 +- docs/generators/typescript-jquery.md | 55 +- docs/generators/typescript-node.md | 51 +- docs/integration.md | 10 +- docs/migration-from-swagger-codegen.md | 40 +- docs/online-openapi-generator.md | 7 +- docs/qna.md | 44 +- docs/roadmap.md | 85 + .../openapitools/codegen/cmd/ConfigHelp.java | 82 +- .../codegen/cmd/ListGenerators.java | 27 +- .../org/openapitools/codegen/CodegenType.java | 1 + website/README.md | 193 + website/blog/2018-12-24-new-website.md | 13 + website/core/EditThisPage.js | 40 + website/core/Footer.js | 101 + website/dynamic/team.yml | 23 + website/i18n/en.json | 377 ++ website/package.json | 17 + website/pages/en/help.js | 54 + website/pages/en/index.js | 308 + website/pages/en/team.js | 93 + website/pages/en/users.js | 48 + website/sidebars.json | 48 + website/siteConfig.js | 227 + website/static/css/custom.css | 72 + website/static/img/color-logo.svg | 14 + .../static/img/companies/angular-schule.svg | 89 + website/static/img/companies/b-com.png | Bin 0 -> 7511 bytes website/static/img/companies/bithost.svg | 38 + website/static/img/companies/boxever.svg | 1 + website/static/img/companies/infotec.png | Bin 0 -> 5185 bytes website/static/img/companies/juststar.png | Bin 0 -> 3061 bytes website/static/img/companies/klarna.svg | 11 + .../static/img/companies/logo-askul-01.gif | Bin 0 -> 4053 bytes website/static/img/companies/metaswitch.svg | 22 + website/static/img/companies/myworkout.png | Bin 0 -> 4643 bytes website/static/img/companies/pepabo.png | Bin 0 -> 4795 bytes website/static/img/companies/raiffeisen.png | Bin 0 -> 3945 bytes website/static/img/companies/reprezen.png | Bin 0 -> 3065 bytes website/static/img/companies/rest-united.png | Bin 0 -> 5875 bytes website/static/img/companies/stingray.png | Bin 0 -> 12636 bytes website/static/img/companies/suva.svg | 8 + website/static/img/companies/telstra.svg | 6 + website/static/img/companies/unblu.svg | 6 + website/static/img/companies/zalando.jpg | Bin 0 -> 6356 bytes website/static/img/docusaurus.svg | 1 + website/static/img/favicon.png | Bin 0 -> 984 bytes website/static/img/favicon/favicon.ico | Bin 0 -> 9662 bytes website/static/img/icons/exchange.svg | 2 + website/static/img/icons/github.svg | 1 + website/static/img/icons/gitter.svg | 1 + website/static/img/icons/newspaper-o.svg | 2 + website/static/img/icons/pencil.svg | 2 + website/static/img/icons/plug.svg | 2 + website/static/img/icons/twitter.svg | 1 + website/static/img/mono-logo.svg | 1 + website/static/img/oss_logo.png | Bin 0 -> 4370 bytes website/static/img/tools/docker.png | Bin 0 -> 4205 bytes website/static/img/tools/homebrew-256x256.png | Bin 0 -> 19350 bytes website/yarn.lock | 5881 +++++++++++++++++ 175 files changed, 10959 insertions(+), 5143 deletions(-) create mode 100755 bin/utils/export_generators_docusaurus_index.sh create mode 100755 docker-compose.yml create mode 100644 docs/conduct.md create mode 100644 docs/contributing.md create mode 100644 docs/core-team.md create mode 100644 docs/faq.md create mode 100644 docs/generators.md create mode 100644 docs/generators/c.md create mode 100644 docs/generators/cpp-qt5-client.md delete mode 100644 docs/generators/cpp-qt5.md create mode 100644 docs/generators/csharp-refactor.md create mode 100644 docs/generators/erlang-proper.md create mode 100644 docs/generators/graphql-schema.md create mode 100644 docs/generators/graphql-server.md create mode 100644 docs/generators/swift3-deprecated.md delete mode 100644 docs/generators/swift3.md create mode 100644 docs/roadmap.md create mode 100755 website/README.md create mode 100644 website/blog/2018-12-24-new-website.md create mode 100644 website/core/EditThisPage.js create mode 100755 website/core/Footer.js create mode 100644 website/dynamic/team.yml create mode 100644 website/i18n/en.json create mode 100644 website/package.json create mode 100755 website/pages/en/help.js create mode 100755 website/pages/en/index.js create mode 100644 website/pages/en/team.js create mode 100755 website/pages/en/users.js create mode 100755 website/sidebars.json create mode 100755 website/siteConfig.js create mode 100755 website/static/css/custom.css create mode 100644 website/static/img/color-logo.svg create mode 100644 website/static/img/companies/angular-schule.svg create mode 100644 website/static/img/companies/b-com.png create mode 100644 website/static/img/companies/bithost.svg create mode 100644 website/static/img/companies/boxever.svg create mode 100644 website/static/img/companies/infotec.png create mode 100644 website/static/img/companies/juststar.png create mode 100644 website/static/img/companies/klarna.svg create mode 100644 website/static/img/companies/logo-askul-01.gif create mode 100644 website/static/img/companies/metaswitch.svg create mode 100644 website/static/img/companies/myworkout.png create mode 100644 website/static/img/companies/pepabo.png create mode 100644 website/static/img/companies/raiffeisen.png create mode 100644 website/static/img/companies/reprezen.png create mode 100644 website/static/img/companies/rest-united.png create mode 100644 website/static/img/companies/stingray.png create mode 100644 website/static/img/companies/suva.svg create mode 100644 website/static/img/companies/telstra.svg create mode 100644 website/static/img/companies/unblu.svg create mode 100644 website/static/img/companies/zalando.jpg create mode 100755 website/static/img/docusaurus.svg create mode 100755 website/static/img/favicon.png create mode 100755 website/static/img/favicon/favicon.ico create mode 100644 website/static/img/icons/exchange.svg create mode 100644 website/static/img/icons/github.svg create mode 100644 website/static/img/icons/gitter.svg create mode 100644 website/static/img/icons/newspaper-o.svg create mode 100644 website/static/img/icons/pencil.svg create mode 100644 website/static/img/icons/plug.svg create mode 100644 website/static/img/icons/twitter.svg create mode 100644 website/static/img/mono-logo.svg create mode 100755 website/static/img/oss_logo.png create mode 100644 website/static/img/tools/docker.png create mode 100644 website/static/img/tools/homebrew-256x256.png create mode 100644 website/yarn.lock diff --git a/README.md b/README.md index 0f155f0c0517..d13bd6728c04 100644 --- a/README.md +++ b/README.md @@ -88,7 +88,7 @@ For old releases, please refer to the [**Release**](https://github.com/OpenAPITo ## [1.2 - Artifacts on Maven Central](#table-of-contents) -You can find our released artefacts on maven central: +You can find our released artifacts on maven central: **Core:** ```xml diff --git a/bin/utils/export_generator.sh b/bin/utils/export_generator.sh index 918ae306eb34..d3836715df49 100755 --- a/bin/utils/export_generator.sh +++ b/bin/utils/export_generator.sh @@ -14,6 +14,4 @@ fi executable="./modules/openapi-generator-cli/target/openapi-generator-cli.jar" -java -jar ${executable} config-help -g ${NAME} --named-header -o docs/generators/${NAME}.md - -echo "Back to the [generators list](README.md)" >> docs/generators/${NAME}.md +java -jar ${executable} config-help -g ${NAME} --named-header --format markdown --markdown-header -o docs/generators/${NAME}.md diff --git a/bin/utils/export_generators_docusaurus_index.sh b/bin/utils/export_generators_docusaurus_index.sh new file mode 100755 index 000000000000..769e0a98db5c --- /dev/null +++ b/bin/utils/export_generators_docusaurus_index.sh @@ -0,0 +1,20 @@ +#!/bin/sh + +SCRIPT="$0" +echo "# START SCRIPT: $SCRIPT" + +executable="./modules/openapi-generator-cli/target/openapi-generator-cli.jar" + +\rm -rf docs/generators.md + +cat > docs/generators.md << EOF +--- +id: generators +title: Generators List +--- + +EOF + +java -jar $executable list --docsite >> docs/generators.md + +echo "Wrote $(pwd)/docs/generators.md" diff --git a/bin/utils/export_generators_readme.sh b/bin/utils/export_generators_readme.sh index 716528d16685..ba1d043432b9 100755 --- a/bin/utils/export_generators_readme.sh +++ b/bin/utils/export_generators_readme.sh @@ -5,4 +5,16 @@ echo "# START SCRIPT: $SCRIPT" executable="./modules/openapi-generator-cli/target/openapi-generator-cli.jar" -java -jar $executable list | sed -e 's/\([A-Z]*\) generators:/* \1 generators:/g' -e 's/- \([a-z0-9\-]*\)/- [\1]\(\1.md\)/g' > docs/generators/README.md +\rm -rf docs/generators.md + +cat > docs/generators.md << EOF +--- +id: generators +title: Generators List +--- + +EOF + +java -jar $executable list | sed -e 's/\([A-Z]*\) generators:/* \1 generators:/g' -e 's/- \([a-z0-9\-]*\)/- [\1]\(generators\/\1.md\)/g' >> docs/generators.md + +echo "Wrote $(pwd)/docs/generators.md" diff --git a/docker-compose.yml b/docker-compose.yml new file mode 100755 index 000000000000..6711192ae1e7 --- /dev/null +++ b/docker-compose.yml @@ -0,0 +1,18 @@ +version: "3" + +services: + docusaurus: + build: . + ports: + - 3000:3000 + - 35729:35729 + volumes: + - ./docs:/app/docs + - ./website/blog:/app/website/blog + - ./website/core:/app/website/core + - ./website/i18n:/app/website/i18n + - ./website/pages:/app/website/pages + - ./website/static:/app/website/static + - ./website/sidebars.json:/app/website/sidebars.json + - ./website/siteConfig.js:/app/website/siteConfig.js + working_dir: /app/website diff --git a/docs/3.0.0-release-note.md b/docs/3.0.0-release-note.md index 12a20c149e56..4929c3ae1ef3 100644 --- a/docs/3.0.0-release-note.md +++ b/docs/3.0.0-release-note.md @@ -1,361 +1,362 @@ -## Docker -7dfd94002 Docker: use correct MAVEN_CONFIG (#182) -b5a0d173d Revise the usage of OpenAPI Generator online (docker image) (#73) -e58dc2c77 Fix COPY in Dockerfile (#64) -9d7feaaeb Fix online generator (docker push) (#58) -9247cd01e Changes for Docker -64037ee59 update docker-related files to ues jdk8 - -## Plug-ins -b6b8c0db8 [gradle-plugin] Initial implementation (#162) -0a28aad73 [MAVEN PLUGIN] Checking for null configOptions before looking for property -9c79297d6 [MAVEN PLUGIN] Use latest version in dependencies snippet -9e1bbe0c1 Add maven wrapper - -## API Clients -### Ada -edf6be8c0 [Ada] bug fix by defining x-is-model-type when property is local to the YML file -9ba74f484 [Ada] Fix GNAT project and server skeleton to avoid sending a response when an error is returned -ea27924f5 [Ada] changed default project/package name, to solve circular dependencies -6b9d38d40 remove trailing spaces in ada template -0de7f972f Fix the Ada server skeleton to check the authsMethods in the Shared_Instance generic package -4bd8fc6e8 Fix 7511: [Ada] Client call is not correct with multiple parameters and application/x-www-urlencoded -3035bc629 [Ada] Hotfix/ada model sort -43f0e8692 Ada code generator corrected: "=>" instead of "->". -7d2b49085 [Ada] wrong order for generated structures in models.ads files -2b2b85eec [Ada] wrong JSON in POST operations - -### C# -0e34bcf4e [csharp] ctor params should always be camelCase -872471996 [csharp] Support arrays of arrays for properties and models -1c4e6b7d4 [csharp] Fix ToJson to work with composition and polymorphism -ed7af73f6 [csharp] Reference this.Configuration in client API template - -### C++ -e796e4c36 [C++] Add linux as a reserve keyword -36f69a034 remove trailing spaces in qt5 c++ templates -f192613f1 fix string type in c++ generator -409015461 fix file type in qt5cpp -a4bcb3bc7 fix datetime and map type for qt5cpp -23b31aba8 [qt5cpp] Fix crash when API return a map container -3b031ed2b [qt5cpp] delete callback data allocated before signal emission -1bb1e44d1 [qt5cpp] Remove qt5 pro.user file -194722015 Qt5cpp plug memleaks part2 -12f3661d6 Qt5cpp plug memleaks -ea4b94842 [qt5cpp] Add nullptr guard to prevent crash when empty model is being serialized -0bf430a80 Qt5cpp Add support for nested containers -0b3ec6b1f fix NPE with cpp qt5, add logic to avoid NPE with composed schema -7c734445b fix file parameter in header file (cpprest) -070b5c00b fix object type declaration in cpprest -bad1885b4 [cpprest] add parameterToString for number type with unspecified format (double) -73bd24db7 [cpprest] Add support for nested vectors -ee2eb74f7 [qt] update Qt client -d82499944 Adding qt project generation fix -9bd94b4db [qt] Fix warning message - -### Clojure -d7e374504 [Clojure] Add util method to set the api-context globally (#93) - -### Dart -f1638a659 [Dart] Allow setting an accessToken for OAuth -a5e26a44f [Dart] - Rework Dart client generator to be flutter-compatible - -### Elixir -f9b2839a3 [Elixir] Check date value before calling to_iso8601 - -### Elm -5a87fe695 [elm] Fix operations with empty responses (#171) -a5cf27b60 Fix Petstore example for Elm (#96) -c522927d5 Fix Elm generator for polymorphism (#78) -7d9fb9f51 Add CI test for Elm in travis (#40) -769a65c95 [Elm] Add support for array schemas -56a0268e3 [elm] missing '->' in Main elm template - -### Erlang -c73118524 [erlang-client] Erlang request utils -049eef9c5 Test erlang client, server petstore -bcc7b788e fix erlang client compilation error - -### Go -acb63fd5e Fix go readme, remove resty install -5d8362d85 Update go client, fix double body read -47614bb76 Properly capitalize exported go types -ee561fcd6 Add withXml option for Go language -0f6696089 [Go] Use consistent indentation in readme -72abb20f2 [Go] Fix operation files clobbering model files. [2.4.0] - -### Haskell -34db79b9b [haskell-http-client] update dependency versions + readme (#81) -e45b3784f Fix NPE with Haskell client generator with OAS3 spec -d3401396f [haskell-http-client] remove duplicates in produces/consumes; fix pathParam paramName issue -4bc99b9da minor fixes to haskell http client generator -2d0bafb6b [haskell-http-client] default InlineMimeTypes=true -9fba9c325 [haskell-http-client] add config options: cabalPackage, cabalVersion, baseModule, requestType, configType - -### Kotlin -a3322fbf7 [kotlin] Add OkHttpClient.Builder to ApiClient. -3c5fb1d80 [kotlin] Add json annotation to each enum value. -39fa375e3 [kotlin] Fix NPE for POST/PUT/PATCH with empty request models. -c599906f1 Kotlin: Correct data_class.mustache to use proper property for inner enum data type -c69925b53 [Kotlin] Fix issues with threetenbp -a811a48c3 minor fix to kotlin client genrator due to merge conflict -914275fe7 [kotlin] support selection of datelibrary -a61d23265 Fixed incorrect renaming of header and query param to camel cases for Kotlin Client template - -### Lua -dbe78e23e [Lua] Improve auto-generated test files -6c79052ac Add auto-generated Lua spec files for APIs, models -38a2c1dde [Lua] Fix Rockpec -a2410b210 Add auto-generated rockspec file to Lua API client -df10c725a Add lua test script, minor fix to Lua API files - -### Java -2e69e6c03 build.gradle should not have commas -1a4e5a4e5 Java client: Add constants for libraries (#163) -7db0201a8 Fix NPEs in Java generator (#154) -4d7ff8cfb JavaDoc fixes for Java/RESTEasy client (#151) -072ce070b resteasy: fix outer enum case (#139) -ccd002966 [Java] rest-assured: fix javadoc in templates -e7410d4c8 Allow $ in java var name -03490e923 Fix Java binary mapping -70b4b55fa Fix performance linting problem with maps in Java ApiClient template -cddcda0fe [Java][Jersey2] Make generated client code thread safe -298ca8d35 use correct jackson date library when using Java 8 -53eeb0c04 [Java] fix connection leak on retrofit OAuth token renewal -61c25e711 [Java] Fixes for retrofit -f02332755 [JAVA] 4709: codegen with parcelableMode fails to build if using arrays in swagger. -4eeb974cb [Java][google-api-client] Fix bug with empty POST request not sending content-type -d4543a99e [Java][retrofit2] file upload sets filename as baseName instead of a dynamic filename -62a930223 [JAVA][Rest-assured] reqSpec() method has been added into api.mustache for requests custom… -fec0363f7 [Java] Add back byte array enhancement -59ff4c198 [Java][library: vertx] Add default value and required parameter support to vertx server temp… -3bd2da9a8 [Java] Fix build warnings -429b96ae7 [JAVA] equals and hashCode for models with byte[] and binary strings -495971c2c [Java] use html entities in javadoc of generated code (#106) -82ee8656f [java] Enum in array of array (#66) -bf7e4e7df Java gson: add @SerializedName value as constant (#22) -30c1448d7 Fix build.gradle for Java RESTEasy client -642c0566d [Java] Use Rx2 Completalbe for Void Retrofit2 responses -72221b1cf Adding @Deprecated to retrofit2 client interfaces. -47111b324 [Java] fix gson deserialize format byte -9e06f7063 [Java] Fix assignment of new object instance to variable -006f084b5 [Java] Allow to set values with setApiPackage(..) and setModelPackage(..) - -### JavaScript/NodeJS -d80e29585 Fix JS test using baseName in default value (#5) -fe15f4690 fix toDefaultValueWithParam in JS -90859575e Fixing variable name typo (instane -> instance) - -### Objective-C -9fb2c29a4 7644 objc deprecated afnetworking datataskwithrequest -5d1874028 add class as a keyword in objc generator -1b8df5c20 Update ObjcClientCodegen.java -246ed5754 restore objc reserved word: property - -### PHP -3beeb4e77 [PHP] Not-required properties now shows as nullable (#129) -37df59d6f [PHP] Adjust the names (script, sample folder, generator) to lang option (#159) -4a5d16b23 [PHP] Fix string length validation -d58835e57 [PHP] Improve: Make validation strict -cf8d8d56f [PHP] Fix code example from README. Variable name was missing when using Basic auth. -0adbf7e51 [PHP] Improve: update sample tests automatically -32cf2f16f [PHP] Non required enum property -3bcf0ff76 [PHP] Add path & file separator (/) to return the correct path when deserializing a file -14e1e1980 [PHP] Improve validation on empty arrays -809e1f4c9 [PHP] Cleanup tests -76907cacd [PHP] declare property headerSelector - -### Python -7184f1ec6 [python] asyncio supports _preload_content; remove unused imports (#107) -d74d2ba03 fix: python clients -8e0a0ebd6 Fix python / tornado body handling -b39c35c76 Fix inconsistency between model name and file name in python client -dfbef4374 Fixed unicode error and supported allow_nonstandard_methods in tornado based python client -f6e0e297e [python-asyncio] tests and fixes - -### R -61e58d649 Add R namespace file - -### Ruby -a08164592 fix ruby parameters in documentation, fix reuqiredParams, optionalParams -8e34f9a98 update to newer version of ruby -aa6b217bb [Ruby] Add auto-generated rubocop config file - -### Rust -b44357394 [Rust] Implement minimal auth support -0b845a57e [Rust] Changes hard coded body to dynamic parameter name - -a3c97753f [Rust] Handles UUID as string -027df610b [Rust] Handle error response statuses -66be7a791 [Rust] Add user agent handling for rust template (master) -3029b7b0f [Rust] Format example with rustfmt - -### Scala -197b4481e normalize akka-scala and Java README -612cfb7af [Akka-scala] Clean unused dependencies such swagger-core -86697fedb [Scala][Gatling] correct body params filename -832919b84 [Scala][Akka] Remove unused dep when model package is empty - - -### Swift -40d5d0990 [Swift4] accept empty content with default client -3b7230b17 [Swift 4] Fix APIHelper to accept array parameter -e22faf4cd [Swift] Add public initializer for modelObject. -b184fb1d9 [Swift3] escape URL parameters -52f606b8d Fix Swift3 test cases and add pom.xml, travis config for iOS test -a3d0f1d4b Swift4: make generated models structs instead of classes - -### TypeScript -f615d823f update ts node dependencies -9ac9bc0dc [TypeScript] enhance ts import -009dcf009 Mark `not required` swagger properties as optional typescript properties -bdd2c2a4e Misc typescript Angular code generation improvements -260375c9e Fix typescript-node generation of array type models -d1933b5fc Fix a problem in the generation of typescript-jquery when we have enum in a query param -20305139b [Feature][TypeScript] request param enum as literal unions -524f162e6 Use supportsES6 flag in ts compilation for language typescript-angular -9b8602311 [TypeScript] Make OpenAPI Generator serialize subclasses properly (#102) -4bc5ffe86 [typescript-angular] add provided in support (#120) -ef832e715 [Feature][TS Angular] improve docs angular import -fc7e08346 [TS][Fetch] Add interfaces option -157e6b7fa [angular] Add option to generate tagged unions -7faaa091c Fix generated module imports in Aurelia APIs -b5f0b24ba [TS] fix object declaration in model - - -## API Servers -### C++ -6fef0a7ff fix string issue with restbed generator -a339422bd move get type declaration method to c++ restbed - -### C# -d9d653016 [aspnetcore] Make the use of Swashbuckle optional (#110) -9a8183ab0 [aspnetcore] Fix openapi.json location rename (#56) -12abfb968 [aspnetcore] Update Dockerfile -866817587 [aspnetcore] Fix string enum generation - -### Java -bd50d368e [JAVA - jaxrs-reasteasy-eap] Add import to models (#179) -7efda597c Fix issue with useBeanValidation option in Java server generators (#160) -71b5de3ed Do not set contextPath for spring-boot (#104) -b73ab0260 jaxrs-cxf-cdi: fix outer enum (#131) -4d7fc046f [JaxRS] Add "validation-api" dependency in jetty (#30) -ce930e7a6 [Jaxrs-cxf] Add bean-level cascaded beanvalidation for pojos (@Valid) -386b9f432 Modify "postProcessOperations" for "jaxrs-cxf-client" -5d92717dc update jaxrs to listent at port 10080 -7c2031675 update artifict id for jaxrs datelib j8 -88c5112f2 Adds support for returning response in jaxrs-spec interfaces -6bf84d5fa [JAXRS-SPEC] Fix lowercase enums sent as uppercase -3a1922bc9 Fix version for "spring-boot-maven-plugin" (#85) -161948657 Add reactive option for Spring Boot (webflux) -ff1178ad7 [Java][Spring] fix missing optional query params -2103fadab Fix package declaration for play-framework -2c6380c84 fix inner item (list, map) for play framework -e33b350c8 Fix an issue in Play Framework generator where a CSV is empty and transferred to the controllerImp with an empty item. -99fc27246 [JAX-RS][Spec] Removes throws Exception. -fe2a44339 Fixes issue (SpringCodeGen dateLibrary "java8-localdatetime" option is ignored). -d890d733f [JaxRS][Java] issue with implFolder on windows, and required fields generation for containers (#88) -c91ce17ae Feature/javaPlayWithAsynchronousControllers -f00a1ef52 [JAVA] Correct consumes/produces attributes for Spring Controllers -d14318cf2 [JAVA][Spring] Optional params with delegate -3f81378d7 [java resteasy] fix string comparison (#134) -5ea3d3bb1 [JAX-RS][SPEC] Bug fix that prevents generating interfaces when interfaceOnly is false. - -### Kotlin -7cad47dd3 [kotlin-server] --library=ktor (barebones implementation) -752b36e66 [Kotlin] Sanitize enumeration name to add underscore when it starts with digits (#77) - -### NodeJS -6d88d073c [NodeJS] make serverPort configurable via CLI option -e7f4fb3c4 Fix nodejs-server path issue in windows platform - -### PHP -d30fcbabb Fixes for php-ze-ph generator -60e3339aa [Feature][PHP] Update for ze-ph generator - -### Python -62b93fc5c [Python][Flask] Handles UUID format - -9999eac52 fix python flask parameter naming - -### Scala -d5c355a59 [Scalatra] Updated the version of Scalatra to the latest (2.6.2) -52322c47c [finch] Allow finch server to compile for CI checks (#7) - -### Ruby -dcad9ae80 [Rails5] make version of the generated Rails stub server to strict Rails 5.0 - -### Rust -37faaf926 [rust-server] API version constant and composite version support -6c7813e79 [rust-server] asynchronous support via hyper v0.11 - -## Documentation -25a6a9d44 html: fix typo in class name - - -## Miscellaneous -f04213285 Cli error message improvements (#172) -0ece706a4 Remove CodegenConfig.fromModel(String, Schema) method (#90) -64f2bea37 Fix getReferenced...() methods in ModelUtils (#157) -16ff5174e Update swagger-parser to 2.0.1 (#123) -76b7307a6 DefaultGenerator: ignore only form param schemas (#74) -a3aabd390 Create a default implementation of delegate if none could be autowired (#92) -ca89af808 Switch to Java 8 -27426f7b5 Cli generator name option, replaces 'language' options in CLI and Maven Plugin (#57) -a1ff50241 Rename datatype to dataType in CodegenProperty (#69) -3b9a2a7c3 CaseFormatLambda has been added, params for Rest-assured client has been refactored (#91) -488910362 Set parameters allowableValues dynamically (#65) -2821f18b9 Meta: set version for "build-helper-maven-plugin" (#89) -82d9e935e Add CORS configuration to openapi-generator-online (#71) -e3814f51d Improvements to online codegen (#55) -6b8079808 Consider minLength, maxLength and pattern in referenced schema (#45) -7c5dfbfa0 Minor improvements to OpenAPI Generator Online (#54) -8dd46a3fb Move online gen from jersey to spring boot (#44) -803821e21 Fix an issue with example generator when array is too large (#46) -673f2bc46 Add CodegenProperty.nameInSnakeCase (#42) -67ebe17dd Fix isPrimitiveType flag for array of form parameters (#38) -10ac4024d Code clean-up: remove field declaration hiding existing fields (#35) -ab9c4b5a6 Code clean-up: Add own private static final LOGGER in each class (#26) -41b0ff351 Code clean-up: remove DefaultCodegen#getSimpleRef(String) (#19) -13f084e7b Fix dataTypeWithEnum for array of form parameters -fd3b883e8 [DefaultCodegen] Fill CodegenOperation::produces with unique media types -db9a899a0 update getSchemaType variable, remove unused import -d74b4cdf8 fix map type and collection format for form parameter (array) -d99f46cff Revise how to obtain the example value -b1eac05b2 Fix form datatype (array of string) -3c666a6d4 Fix array of form parameters -1492df6ce Override server port for Jetty configuration -622a75b2c Fix data type shadowing -861d11d01 use vendor extension in operation to set the body parameter name -80c8b92cb add postProcessParamter for body, form parameter -7fe555a51 Set collectionFormat default only for array -16589de97 default collection format to csv according to the spec -edbe4902a Consider '$ref' for consumes and produces in CodegenOperation -e24238a35 Improve getter name handling for boolean properties -6e2ca294b update discriminator to discriminatorName -74075c087 Primitive datatype in Schema components -d8abd4a14 support map in body parameter -186594115 Update swagger-core to 2.0.1 -2034f61e5 Add HideGenerationTimestamp getter and setter in the CodegenConfig interface -d0e2d7684 Getter and Setter for hideGenerationTimestamp -adbde2fb6 replace fromOperation with postProcessOperations -9d1ae0dd2 fix bigdecimal in default codegen -ffa0e115d fix default value and type declaration -0e744adb8 Apply collection format to SIMPLE enum style -36ed29852 Tweak tests according to the parameter order changes -17b082793 Move 'enum_query_double' to parameters section -28fcf48f4 Add a method returns discriminator name -7daa2ec5d Fix broken discriminator -faa901640 Replace with the helper function: `getTypeDeclaration` -c8650d0e3 Make optional properties in models optional parameters -40c30dd2f Fix inputSpec for multi module builds -5326152cc add option to reorder form/body parameter -d1850091a Improve JMeter Template -fedfb0cda Factorize addOption/addSwitch method -e73eeb4fd fix for stripping prefix on single enums -13e3db59e Add operationIdOriginal to store the original operationId -0b2d80569 Expose getter/setter for serverPort to facilitate testing -8e270f465 add vendorExtensions field in CodegenSecurity class -1ee85de94 Added Intelli J ignore -7b8e409cf Added gitignore generation function - - - +--- +id: release-3-0-0 +title: Release Notes: 3.0.0 +sidebar_label: Release Notes: 3.0.0 +--- + +* ## Docker +* 7dfd94002 Docker: use correct MAVEN_CONFIG (#182) +* b5a0d173d Revise the usage of OpenAPI Generator online (docker image) (#73) +* e58dc2c77 Fix COPY in Dockerfile (#64) +* 9d7feaaeb Fix online generator (docker push) (#58) +* 9247cd01e Changes for Docker +* 64037ee59 update docker-related files to ues jdk8 + +* ## Plug-ins +* b6b8c0db8 \[gradle-plugin] Initial implementation (#162) +* 0a28aad73 \[MAVEN PLUGIN] Checking for null configOptions before looking for property +* 9c79297d6 \[MAVEN PLUGIN] Use latest version in dependencies snippet +* 9e1bbe0c1 Add maven wrapper + +* ## API Clients +* ### Ada +* edf6be8c0 \[Ada] bug fix by defining x-is-model-type when property is local to the YML file +* 9ba74f484 \[Ada] Fix GNAT project and server skeleton to avoid sending a response when an error is returned +* ea27924f5 \[Ada] changed default project/package name, to solve circular dependencies +* 6b9d38d40 remove trailing spaces in ada template +* 0de7f972f Fix the Ada server skeleton to check the authsMethods in the Shared_Instance generic package +* 4bd8fc6e8 Fix 7511: \[Ada] Client call is not correct with multiple parameters and application/x-www-urlencoded +* 3035bc629 \[Ada] Hotfix/ada model sort +* 43f0e8692 Ada code generator corrected: "=>" instead of "->". +* 7d2b49085 \[Ada] wrong order for generated structures in models.ads files +* 2b2b85eec \[Ada] wrong JSON in POST operations + +* ### C# +* 0e34bcf4e \[csharp] ctor params should always be camelCase +* 872471996 \[csharp] Support arrays of arrays for properties and models +* 1c4e6b7d4 \[csharp] Fix ToJson to work with composition and polymorphism +* ed7af73f6 \[csharp] Reference this.Configuration in client API template + +* ### C++ +* e796e4c36 \[C++] Add linux as a reserve keyword +* 36f69a034 remove trailing spaces in qt5 c++ templates +* f192613f1 fix string type in c++ generator +* 409015461 fix file type in qt5cpp +* a4bcb3bc7 fix datetime and map type for qt5cpp +* 23b31aba8 \[qt5cpp] Fix crash when API return a map container +* 3b031ed2b \[qt5cpp] delete callback data allocated before signal emission +* 1bb1e44d1 \[qt5cpp] Remove qt5 pro.user file +* 194722015 Qt5cpp plug memleaks part2 +* 12f3661d6 Qt5cpp plug memleaks +* ea4b94842 \[qt5cpp] Add nullptr guard to prevent crash when empty model is being serialized +* 0bf430a80 Qt5cpp Add support for nested containers +* 0b3ec6b1f fix NPE with cpp qt5, add logic to avoid NPE with composed schema +* 7c734445b fix file parameter in header file (cpprest) +* 070b5c00b fix object type declaration in cpprest +* bad1885b4 \[cpprest] add parameterToString for number type with unspecified format (double) +* 73bd24db7 \[cpprest] Add support for nested vectors +* ee2eb74f7 \[qt] update Qt client +* d82499944 Adding qt project generation fix +* 9bd94b4db \[qt] Fix warning message + +* ### Clojure +* d7e374504 \[Clojure] Add util method to set the api-context globally (#93) + +* ### Dart +* f1638a659 \[Dart] Allow setting an accessToken for OAuth +* a5e26a44f \[Dart] - Rework Dart client generator to be flutter-compatible + +* ### Elixir +* f9b2839a3 \[Elixir] Check date value before calling to_iso8601 + +* ### Elm +* 5a87fe695 \[elm] Fix operations with empty responses (#171) +* a5cf27b60 Fix Petstore example for Elm (#96) +* c522927d5 Fix Elm generator for polymorphism (#78) +* 7d9fb9f51 Add CI test for Elm in travis (#40) +* 769a65c95 \[Elm] Add support for array schemas +* 56a0268e3 \[elm] missing '->' in Main elm template + +* ### Erlang +* c73118524 \[erlang-client] Erlang request utils +* 049eef9c5 Test erlang client, server petstore +* bcc7b788e fix erlang client compilation error + +* ### Go +* acb63fd5e Fix go readme, remove resty install +* 5d8362d85 Update go client, fix double body read +* 47614bb76 Properly capitalize exported go types +* ee561fcd6 Add withXml option for Go language +* 0f6696089 \[Go] Use consistent indentation in readme +* 72abb20f2 \[Go] Fix operation files clobbering model files. \[2.4.0] + +* ### Haskell +* 34db79b9b \[haskell-http-client] update dependency versions + readme (#81) +* e45b3784f Fix NPE with Haskell client generator with OAS3 spec +* d3401396f \[haskell-http-client] remove duplicates in produces/consumes; fix pathParam paramName issue +* 4bc99b9da minor fixes to haskell http client generator +* 2d0bafb6b \[haskell-http-client] default InlineMimeTypes=true +* 9fba9c325 \[haskell-http-client] add config options: cabalPackage, cabalVersion, baseModule, requestType, configType + +* ### Kotlin +* a3322fbf7 \[kotlin] Add OkHttpClient.Builder to ApiClient. +* 3c5fb1d80 \[kotlin] Add json annotation to each enum value. +* 39fa375e3 \[kotlin] Fix NPE for POST/PUT/PATCH with empty request models. +* c599906f1 Kotlin: Correct data_class.mustache to use proper property for inner enum data type +* c69925b53 \[Kotlin] Fix issues with threetenbp +* a811a48c3 minor fix to kotlin client genrator due to merge conflict +* 914275fe7 \[kotlin] support selection of datelibrary +* a61d23265 Fixed incorrect renaming of header and query param to camel cases for Kotlin Client template + +* ### Lua +* dbe78e23e \[Lua] Improve auto-generated test files +* 6c79052ac Add auto-generated Lua spec files for APIs, models +* 38a2c1dde \[Lua] Fix Rockpec +* a2410b210 Add auto-generated rockspec file to Lua API client +* df10c725a Add lua test script, minor fix to Lua API files + +* ### Java +* 2e69e6c03 build.gradle should not have commas +* 1a4e5a4e5 Java client: Add constants for libraries (#163) +* 7db0201a8 Fix NPEs in Java generator (#154) +* 4d7ff8cfb JavaDoc fixes for Java/RESTEasy client (#151) +* 072ce070b resteasy: fix outer enum case (#139) +* ccd002966 \[Java] rest-assured: fix javadoc in templates +* e7410d4c8 Allow $ in java var name +* 03490e923 Fix Java binary mapping +* 70b4b55fa Fix performance linting problem with maps in Java ApiClient template +* cddcda0fe \[Java][Jersey2] Make generated client code thread safe +* 298ca8d35 use correct jackson date library when using Java 8 +* 53eeb0c04 \[Java] fix connection leak on retrofit OAuth token renewal +* 61c25e711 \[Java] Fixes for retrofit +* f02332755 \[JAVA] 4709: codegen with parcelableMode fails to build if using arrays in swagger. +* 4eeb974cb \[Java][google-api-client] Fix bug with empty POST request not sending content-type +* d4543a99e \[Java][retrofit2] file upload sets filename as baseName instead of a dynamic filename +* 62a930223 \[JAVA][Rest-assured] reqSpec() method has been added into api.mustache for requests custom… +* fec0363f7 \[Java] Add back byte array enhancement +* 59ff4c198 \[Java][library: vertx] Add default value and required parameter support to vertx server temp… +* 3bd2da9a8 \[Java] Fix build warnings +* 429b96ae7 \[JAVA] equals and hashCode for models with byte[] and binary strings +* 495971c2c \[Java] use html entities in javadoc of generated code (#106) +* 82ee8656f \[java] Enum in array of array (#66) +* bf7e4e7df Java gson: add @SerializedName value as constant (#22) +* 30c1448d7 Fix build.gradle for Java RESTEasy client +* 642c0566d \[Java] Use Rx2 Completalbe for Void Retrofit2 responses +* 72221b1cf Adding @Deprecated to retrofit2 client interfaces. +* 47111b324 \[Java] fix gson deserialize format byte +* 9e06f7063 \[Java] Fix assignment of new object instance to variable +* 006f084b5 \[Java] Allow to set values with setApiPackage(..) and setModelPackage(..) + +* ### JavaScript/NodeJS +* d80e29585 Fix JS test using baseName in default value (#5) +* fe15f4690 fix toDefaultValueWithParam in JS +* 90859575e Fixing variable name typo (instane -> instance) + +* ### Objective-C +* 9fb2c29a4 7644 objc deprecated afnetworking datataskwithrequest +* 5d1874028 add class as a keyword in objc generator +* 1b8df5c20 Update ObjcClientCodegen.java +* 246ed5754 restore objc reserved word: property + +* ### PHP +* 3beeb4e77 \[PHP] Not-required properties now shows as nullable (#129) +* 37df59d6f \[PHP] Adjust the names (script, sample folder, generator) to lang option (#159) +* 4a5d16b23 \[PHP] Fix string length validation +* d58835e57 \[PHP] Improve: Make validation strict +* cf8d8d56f \[PHP] Fix code example from README. Variable name was missing when using Basic auth. +* 0adbf7e51 \[PHP] Improve: update sample tests automatically +* 32cf2f16f \[PHP] Non required enum property +* 3bcf0ff76 \[PHP] Add path & file separator (/) to return the correct path when deserializing a file +* 14e1e1980 \[PHP] Improve validation on empty arrays +* 809e1f4c9 \[PHP] Cleanup tests +* 76907cacd \[PHP] declare property headerSelector + +* ### Python +* 7184f1ec6 \[python] asyncio supports _preload_content; remove unused imports (#107) +* d74d2ba03 fix: python clients +* 8e0a0ebd6 Fix python / tornado body handling +* b39c35c76 Fix inconsistency between model name and file name in python client +* dfbef4374 Fixed unicode error and supported allow_nonstandard_methods in tornado based python client +* f6e0e297e \[python-asyncio] tests and fixes + +* ### R +* 61e58d649 Add R namespace file + +* ### Ruby +* a08164592 fix ruby parameters in documentation, fix reuqiredParams, optionalParams +* 8e34f9a98 update to newer version of ruby +* aa6b217bb \[Ruby] Add auto-generated rubocop config file + +* ### Rust +* b44357394 \[Rust] Implement minimal auth support +* 0b845a57e \[Rust] Changes hard coded body to dynamic parameter name - +* a3c97753f \[Rust] Handles UUID as string +* 027df610b \[Rust] Handle error response statuses +* 66be7a791 \[Rust] Add user agent handling for rust template (master) +* 3029b7b0f \[Rust] Format example with rustfmt + +* ### Scala +* 197b4481e normalize akka-scala and Java README +* 612cfb7af \[Akka-scala] Clean unused dependencies such swagger-core +* 86697fedb \[Scala][Gatling] correct body params filename +* 832919b84 \[Scala][Akka] Remove unused dep when model package is empty + +* ### Swift +* 40d5d0990 \[Swift4] accept empty content with default client +* 3b7230b17 \[Swift 4] Fix APIHelper to accept array parameter +* e22faf4cd \[Swift] Add public initializer for modelObject. +* b184fb1d9 \[Swift3] escape URL parameters +* 52f606b8d Fix Swift3 test cases and add pom.xml, travis config for iOS test +* a3d0f1d4b Swift4: make generated models structs instead of classes + +* ### TypeScript +* f615d823f update ts node dependencies +* 9ac9bc0dc \[TypeScript] enhance ts import +* 009dcf009 Mark `not required` swagger properties as optional typescript properties +* bdd2c2a4e Misc typescript Angular code generation improvements +* 260375c9e Fix typescript-node generation of array type models +* d1933b5fc Fix a problem in the generation of typescript-jquery when we have enum in a query param +* 20305139b \[Feature][TypeScript] request param enum as literal unions +* 524f162e6 Use supportsES6 flag in ts compilation for language typescript-angular +* 9b8602311 \[TypeScript] Make OpenAPI Generator serialize subclasses properly (#102) +* 4bc5ffe86 \[typescript-angular] add provided in support (#120) +* ef832e715 \[Feature][TS Angular] improve docs angular import +* fc7e08346 \[TS][Fetch] Add interfaces option +* 157e6b7fa \[angular] Add option to generate tagged unions +* 7faaa091c Fix generated module imports in Aurelia APIs +* b5f0b24ba \[TS] fix object declaration in model + +* ## API Servers +* ### C++ +* 6fef0a7ff fix string issue with restbed generator +* a339422bd move get type declaration method to c++ restbed + +* ### C# +* d9d653016 \[aspnetcore] Make the use of Swashbuckle optional (#110) +* 9a8183ab0 \[aspnetcore] Fix openapi.json location rename (#56) +* 12abfb968 \[aspnetcore] Update Dockerfile +* 866817587 \[aspnetcore] Fix string enum generation + +* ### Java +* bd50d368e \[JAVA - jaxrs-reasteasy-eap] Add import to models (#179) +* 7efda597c Fix issue with useBeanValidation option in Java server generators (#160) +* 71b5de3ed Do not set contextPath for spring-boot (#104) +* b73ab0260 jaxrs-cxf-cdi: fix outer enum (#131) +* 4d7fc046f \[JaxRS] Add "validation-api" dependency in jetty (#30) +* ce930e7a6 \[Jaxrs-cxf] Add bean-level cascaded beanvalidation for pojos (@Valid) +* 386b9f432 Modify "postProcessOperations" for "jaxrs-cxf-client" +* 5d92717dc update jaxrs to listent at port 10080 +* 7c2031675 update artifict id for jaxrs datelib j8 +* 88c5112f2 Adds support for returning response in jaxrs-spec interfaces +* 6bf84d5fa \[JAXRS-SPEC] Fix lowercase enums sent as uppercase +* 3a1922bc9 Fix version for "spring-boot-maven-plugin" (#85) +* 161948657 Add reactive option for Spring Boot (webflux) +* ff1178ad7 \[Java][Spring] fix missing optional query params +* 2103fadab Fix package declaration for play-framework +* 2c6380c84 fix inner item (list, map) for play framework +* e33b350c8 Fix an issue in Play Framework generator where a CSV is empty and transferred to the controllerImp with an empty item. +* 99fc27246 \[JAX-RS][Spec] Removes throws Exception. +* fe2a44339 Fixes issue (SpringCodeGen dateLibrary "java8-localdatetime" option is ignored). +* d890d733f \[JaxRS][Java] issue with implFolder on windows, and required fields generation for containers (#88) +* c91ce17ae Feature/javaPlayWithAsynchronousControllers +* f00a1ef52 \[JAVA] Correct consumes/produces attributes for Spring Controllers +* d14318cf2 \[JAVA][Spring] Optional params with delegate +* 3f81378d7 \[java resteasy] fix string comparison (#134) +* 5ea3d3bb1 \[JAX-RS][SPEC] Bug fix that prevents generating interfaces when interfaceOnly is false. + +* ### Kotlin +* 7cad47dd3 \[kotlin-server] --library=ktor (barebones implementation) +* 752b36e66 \[Kotlin] Sanitize enumeration name to add underscore when it starts with digits (#77) + +* ### NodeJS +* 6d88d073c \[NodeJS] make serverPort configurable via CLI option +* e7f4fb3c4 Fix nodejs-server path issue in windows platform + +* ### PHP +* d30fcbabb Fixes for php-ze-ph generator +* 60e3339aa \[Feature][PHP] Update for ze-ph generator + +* ### Python +* 62b93fc5c \[Python][Flask] Handles UUID format - +* 9999eac52 fix python flask parameter naming + +* ### Scala +* d5c355a59 \[Scalatra] Updated the version of Scalatra to the latest (2.6.2) +* 52322c47c \[finch] Allow finch server to compile for CI checks (#7) + +* ### Ruby +* dcad9ae80 \[Rails5] make version of the generated Rails stub server to strict Rails 5.0 + +* ### Rust +* 37faaf926 \[rust-server] API version constant and composite version support +* 6c7813e79 \[rust-server] asynchronous support via hyper v0.11 + +* ## Documentation +* 25a6a9d44 html: fix typo in class name + + +* ## Miscellaneous +* f04213285 Cli error message improvements (#172) +* 0ece706a4 Remove CodegenConfig.fromModel(String, Schema) method (#90) +* 64f2bea37 Fix getReferenced...() methods in ModelUtils (#157) +* 16ff5174e Update swagger-parser to 2.0.1 (#123) +* 76b7307a6 DefaultGenerator: ignore only form param schemas (#74) +* a3aabd390 Create a default implementation of delegate if none could be autowired (#92) +* ca89af808 Switch to Java 8 +* 27426f7b5 Cli generator name option, replaces 'language' options in CLI and Maven Plugin (#57) +* a1ff50241 Rename datatype to dataType in CodegenProperty (#69) +* 3b9a2a7c3 CaseFormatLambda has been added, params for Rest-assured client has been refactored (#91) +* 488910362 Set parameters allowableValues dynamically (#65) +* 2821f18b9 Meta: set version for "build-helper-maven-plugin" (#89) +* 82d9e935e Add CORS configuration to openapi-generator-online (#71) +* e3814f51d Improvements to online codegen (#55) +* 6b8079808 Consider minLength, maxLength and pattern in referenced schema (#45) +* 7c5dfbfa0 Minor improvements to OpenAPI Generator Online (#54) +* 8dd46a3fb Move online gen from jersey to spring boot (#44) +* 803821e21 Fix an issue with example generator when array is too large (#46) +* 673f2bc46 Add CodegenProperty.nameInSnakeCase (#42) +* 67ebe17dd Fix isPrimitiveType flag for array of form parameters (#38) +* 10ac4024d Code clean-up: remove field declaration hiding existing fields (#35) +* ab9c4b5a6 Code clean-up: Add own private static final LOGGER in each class (#26) +* 41b0ff351 Code clean-up: remove DefaultCodegen#getSimpleRef(String) (#19) +* 13f084e7b Fix dataTypeWithEnum for array of form parameters +* fd3b883e8 \[DefaultCodegen] Fill CodegenOperation::produces with unique media types +* db9a899a0 update getSchemaType variable, remove unused import +* d74b4cdf8 fix map type and collection format for form parameter (array) +* d99f46cff Revise how to obtain the example value +* b1eac05b2 Fix form datatype (array of string) +* 3c666a6d4 Fix array of form parameters +* 1492df6ce Override server port for Jetty configuration +* 622a75b2c Fix data type shadowing +* 861d11d01 use vendor extension in operation to set the body parameter name +* 80c8b92cb add postProcessParamter for body, form parameter +* 7fe555a51 Set collectionFormat default only for array +* 16589de97 default collection format to csv according to the spec +* edbe4902a Consider '$ref' for consumes and produces in CodegenOperation +* e24238a35 Improve getter name handling for boolean properties +* 6e2ca294b update discriminator to discriminatorName +* 74075c087 Primitive datatype in Schema components +* d8abd4a14 support map in body parameter +* 186594115 Update swagger-core to 2.0.1 +* 2034f61e5 Add HideGenerationTimestamp getter and setter in the CodegenConfig interface +* d0e2d7684 Getter and Setter for hideGenerationTimestamp +* adbde2fb6 replace fromOperation with postProcessOperations +* 9d1ae0dd2 fix bigdecimal in default codegen +* ffa0e115d fix default value and type declaration +* 0e744adb8 Apply collection format to SIMPLE enum style +* 36ed29852 Tweak tests according to the parameter order changes +* 17b082793 Move 'enum_query_double' to parameters section +* 28fcf48f4 Add a method returns discriminator name +* 7daa2ec5d Fix broken discriminator +* faa901640 Replace with the helper function: `getTypeDeclaration` +* c8650d0e3 Make optional properties in models optional parameters +* 40c30dd2f Fix inputSpec for multi module builds +* 5326152cc add option to reorder form/body parameter +* d1850091a Improve JMeter Template +* fedfb0cda Factorize addOption/addSwitch method +* e73eeb4fd fix for stripping prefix on single enums +* 13e3db59e Add operationIdOriginal to store the original operationId +* 0b2d80569 Expose getter/setter for serverPort to facilitate testing +* 8e270f465 add vendorExtensions field in CodegenSecurity class +* 1ee85de94 Added Intelli J ignore +* 7b8e409cf Added gitignore generation function diff --git a/docs/conduct.md b/docs/conduct.md new file mode 100644 index 000000000000..3f00ddca67f1 --- /dev/null +++ b/docs/conduct.md @@ -0,0 +1,49 @@ +--- +id: code-of-conduct +title: Contributor Covenant Code of Conduct +--- + +## Our Pledge + +In the interest of fostering an open and welcoming environment, we as contributors and maintainers pledge to making participation in our project and our community a harassment-free experience for everyone, regardless of age, body size, disability, ethnicity, gender identity and expression, level of experience, nationality, personal appearance, race, religion, or sexual identity and orientation. + +## Our Standards + +Examples of behavior that contributes to creating a positive environment include: + +* Using welcoming and inclusive language +* Being respectful of differing viewpoints and experiences +* Gracefully accepting constructive criticism +* Focusing on what is best for the community +* Showing empathy towards other community members + +Examples of unacceptable behavior by participants include: + +* The use of sexualized language or imagery and unwelcome sexual attention or advances +* Trolling, insulting/derogatory comments, and personal or political attacks +* Public or private harassment +* Publishing others' private information, such as a physical or electronic address, without explicit permission +* Other conduct which could reasonably be considered inappropriate in a professional setting + +## Our Responsibilities + +Project maintainers are responsible for clarifying the standards of acceptable behavior and are expected to take appropriate and fair corrective action in response to any instances of unacceptable behavior. + +Project maintainers have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct, or to ban temporarily or permanently any contributor for other behaviors that they deem inappropriate, threatening, offensive, or harmful. + +## Scope + +This Code of Conduct applies both within project spaces and in public spaces when an individual is representing the project or its community. Examples of representing a project or community include using an official project e-mail address, posting via an official social media account, or acting as an appointed representative at an online or offline event. Representation of a project may be further defined and clarified by project maintainers. + +## Enforcement + +Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by contacting the project team at team@openapitools.org. The project team will review and investigate all complaints, and will respond in a way that it deems appropriate to the circumstances. The project team is obligated to maintain confidentiality with regard to the reporter of an incident. Further details of specific enforcement policies may be posted separately. + +Project maintainers who do not follow or enforce the Code of Conduct in good faith may face temporary or permanent repercussions as determined by other members of the project's leadership. + +## Attribution + +This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4, available at [http://contributor-covenant.org/version/1/4][version] + +[homepage]: http://contributor-covenant.org +[version]: http://contributor-covenant.org/version/1/4/ diff --git a/docs/contributing.md b/docs/contributing.md new file mode 100644 index 000000000000..1b6f68801f23 --- /dev/null +++ b/docs/contributing.md @@ -0,0 +1,106 @@ +--- +id: contributing +title: Guidelines For Contributing +--- + +## Before submitting an issue + + - If you're not using the latest master to generate API clients or server stubs, please give it another try by pulling the latest master as the issue may have already been addressed. Ref: [Getting Started](https://github.com/openapitools/openapi-generator#getting-started) + - Search the [open issue](https://github.com/openapitools/openapi-generator/issues) and [closed issue](https://github.com/openapitools/openapi-generator/issues?q=is%3Aissue+is%3Aclosed) to ensure no one else has reported something similar before. + - File an [issue ticket](https://github.com/openapitools/openapi-generator/issues/new) by providing all the required information. + - Test with the latest master by building the JAR locally to see if the issue has already been addressed. + - You can also make a suggestion or ask a question by opening an "issue". + +## Before submitting a PR + + - Search the [open issue](https://github.com/openapitools/openapi-generator/issues) to ensure no one else has reported something similar and no one is actively working on similar proposed change. + - If no one has suggested something similar, open an ["issue"](https://github.com/openapitools/openapi-generator/issues) with your suggestion to gather feedback from the community. + - If you're adding a new option to a generator, please consider using the `-t` option with customized templates instead or start a discussion first by opening an issue as we want to avoid adding too many options to the generator. + - It's recommended to **create a new git branch** for the change so that the merge commit message looks nicer in the commit history. + +## How to contribute + +### git + +If you're new to git, you may find the following FAQs useful: + +https://github.com/openapitools/openapi-generator/wiki/FAQ#git + +### Branches + +Please file the pull request against the correct branch, e.g. `master` for non-breaking changes. See the [Git Branches](https://github.com/OpenAPITools/openapi-generator/wiki/Git-Branches) page for more information. + +### Code generators + +All the code generators can be found in [modules/openapi-generator/src/main/java/org/openapitools/codegen/languages](https://github.com/openapitools/openapi-generator/tree/master/modules/openapi-generator/src/main/java/org/openapitools/codegen/languages) + +### Templates + +All the templates ([mustache](https://mustache.github.io/)) can be found in [modules/openapi-generator/src/main/resources](https://github.com/openapitools/openapi-generator/tree/master/modules/openapi-generator/src/main/resources). + +For a list of variables available in the template, please refer to this [page](https://github.com/openapitools/openapi-generator/wiki/Mustache-Template-Variables) + + +### Style guide +Code change should conform to the programming style guide of the respective languages: +- Ada: https://en.wikibooks.org/wiki/Ada_Style_Guide/Source_Code_Presentation +- Android: https://source.android.com/source/code-style.html +- Bash: https://github.com/bahamas10/bash-style-guide +- C#: https://msdn.microsoft.com/en-us/library/vstudio/ff926074.aspx +- C++: https://google.github.io/styleguide/cppguide.html +- C++ (Tizen): https://wiki.tizen.org/Native_Platform_Coding_Idiom_and_Style_Guide#C.2B.2B_Coding_Style +- Clojure: https://github.com/bbatsov/clojure-style-guide +- Dart: https://www.dartlang.org/guides/language/effective-dart/style +- Elixir: https://github.com/christopheradams/elixir_style_guide +- Eiffel: https://www.eiffel.org/doc/eiffel/Coding%20Standards +- Erlang: https://github.com/inaka/erlang_guidelines +- Haskell: https://github.com/tibbe/haskell-style-guide/blob/master/haskell-style.md +- Java: https://google.github.io/styleguide/javaguide.html +- JavaScript: https://github.com/airbnb/javascript/ +- Kotlin: https://kotlinlang.org/docs/reference/coding-conventions.html +- Groovy: http://groovy-lang.org/style-guide.html +- Go: https://github.com/golang/go/wiki/CodeReviewComments +- ObjC: https://github.com/NYTimes/objective-c-style-guide +- Perl: http://perldoc.perl.org/perlstyle.html +- PHP: https://github.com/php-fig/fig-standards/blob/master/accepted/PSR-2-coding-style-guide.md +- PowerShell: https://msdn.microsoft.com/en-us/library/dd878270(v=vs.85).aspx +- Python: https://www.python.org/dev/peps/pep-0008/ +- R: https://google.github.io/styleguide/Rguide.xml +- Ruby: https://github.com/bbatsov/ruby-style-guide +- Rust: https://github.com/rust-lang-nursery/fmt-rfcs/blob/master/guide/guide.md (the default [rustfmt](https://github.com/rust-lang-nursery/rustfmt) configuration) +- Scala: http://docs.scala-lang.org/style/ +- Swift: [Apple Developer](https://developer.apple.com/library/prerelease/ios/documentation/Swift/Conceptual/Swift_Programming_Language/TheBasics.html) +- TypeScript: https://github.com/Microsoft/TypeScript/wiki/Coding-guidelines + +For other languages, feel free to suggest. + +You may find the current code base not 100% conform to the coding style and we welcome contributions to fix those. + +For [Vendor Extensions](https://github.com/OAI/OpenAPI-Specification/blob/master/versions/2.0.md#vendorExtensions), please follow the naming convention below: +- For general vendor extension, use lower case and hyphen. e.g. `x-is-unique`, `x-content-type` +- For language-specified vendor extension, put it in the form of `x-{lang}-{extension-name}`. e.g. `x-objc-operation-id`, `x-java-feign-retry-limit` +- For a list of existing vendor extensions in use, please refer to https://github.com/openapitools/openapi-generator/wiki/Vendor-Extensions. If you've added new vendor extensions as part of your PR, please update the wiki page. + +### Testing + +To add test cases (optional) covering the change in the code generator, please refer to [modules/openapi-generator/src/test/java/org/openapitools/codegen](https://github.com/openapitools/openapi-generator/tree/master/modules/openapi-generator/src/test/java/org/openapitools/codegen) + +To test the templates, please perform the following: +- Update the Petstore sample by running the shell script under `bin` folder. For example, run `./bin/ruby-petstore.sh` to update the Ruby PetStore API client under [`samples/client/petstore/ruby`](https://github.com/openapitools/openapi-generator/tree/master/samples/client/petstore/ruby) For Windows, the batch files can be found under `bin\windows` folder. (If you find that there are new files generated or unexpected changes as a result of the update, that's not unusual as the test cases are added to the OpenAPI spec from time to time. If you've questions or concerns, please open a ticket to start a discussion) +- Run the tests in the sample folder, e.g. in `samples/client/petstore/ruby`, run `mvn integration-test -rf :RubyPetstoreClientTests`. (some languages may not contain unit testing for Petstore and we're looking for contribution from the community to implement those tests) +- Finally, git commit the updated samples files: `git commit -a` + (`git add -A` if added files with new test cases) +- For new test cases, please add to the [Fake Petstore spec](https://github.com/OpenAPITools/openapi-generator/blob/master/modules/openapi-generator/src/test/resources/2_0/petstore-with-fake-endpoints-models-for-testing.yaml) + +To start the CI tests, you can run `mvn verify -Psamples` (assuming you've all the required tools installed to run tests for different languages) or you can leverage http://travis-ci.org to run the CI tests by adding your own openapi-generator repository. + +### Tips +- Smaller changes are easier to review +- [Optional] For bug fixes, provide a OpenAPI Spec to repeat the issue so that the reviewer can use it to confirm the fix +- Add test case(s) to cover the change +- Document the fix in the code to make the code more readable +- Make sure test cases passed after the change (one way is to leverage https://travis-ci.org/ to run the CI tests) +- File a PR with meaningful title, description and commit messages. +- Recommended git settings + - `git config --global core.autocrlf input` to tell Git convert CRLF to LF on commit but not the other way around +- To close an issue (e.g. issue 1542) automatically after a PR is merged, use keywords "fix", "close", "resolve" in the PR description, e.g. `fix #1542`. (Ref: [closing issues using keywords](https://help.github.com/articles/closing-issues-using-keywords/)) diff --git a/docs/core-team.md b/docs/core-team.md new file mode 100644 index 000000000000..e782b2d03f52 --- /dev/null +++ b/docs/core-team.md @@ -0,0 +1,12 @@ +--- +id: core-team +title: Core Team Members +--- + +* [@wing328](https://github.com/wing328) (2015/07) +* [@jimschubert](https://github.com/jimschubert) (2016/05) +* [@cbornet](https://github.com/cbornet) (2016/05) +* [@jaz-ah](https://github.com/jaz-ah) (2016/05) +* [@ackintosh](https://github.com/ackintosh) (2018/02) +* [@JFCote](https://github.com/JFCote) (2018/03) +* [@jmini](https://github.com/jmini) (2018/04) \ No newline at end of file diff --git a/docs/customization.md b/docs/customization.md index 32b784d7f6bc..18d8be5bbe22 100644 --- a/docs/customization.md +++ b/docs/customization.md @@ -1,6 +1,9 @@ -## Customization +--- +id: customization +title: Customization +--- -### Modifying a template +## Modifying a template Clone OpenAPI Generator and navigate to `modules/openapi-generator/src/main/resources/${template}`, where `${template}` is the name of the generator you wish to modify. For example, if you are looking for the C# template, it's named `csharp`. This directory contains all the templates used to generate your target client/server/doc output. @@ -20,7 +23,7 @@ java -jar modules/openapi-generator-cli/target/openapi-generator-cli.jar generat _**Note:** You cannot use this approach to create new templates, only override existing ones. If you'd like to create a new generator within the project, see `new.sh` in the repository root._ -### Creating a new template +## Creating a new template If none of the templates suit your needs, you can create a brand new template. OpenAPI Generator can help with this, using the `meta` command: @@ -35,7 +38,7 @@ These names can be anything you like. If you are building a client for the white **NOTE** Convention is to use kebab casing for names passed to `-n`. Example, `scala-finatra` would become `ScalaFinatraGenerator`. -#### Use your new generator with the CLI +### Use your new generator with the CLI To compile your library, enter the `out/generators/my-codegen` directory, run `mvn package` and execute the generator: @@ -65,7 +68,7 @@ java -cp out/codegens/customCodegen/target/my-codegen-openapi-generator-1.0.0.ja -o ./out/myClient ``` -#### Use your new generator with the maven plugin +### Use your new generator with the maven plugin Install your library to your local maven repository by running: @@ -106,7 +109,7 @@ You can use this as additional dependency of the `openapi-generator-maven-plugin If you publish your artifact to a distant maven repository, do not forget to add this repository as `pluginRepository` for your project. -### Selective generation +## Selective generation You may not want to generate *all* models in your project. Likewise you may want just one or two apis to be written. If that's the case, you can use system properties to control the output: The default is generate *everything* supported by the specific library. Once you enable a feature, it will restrict the contents generated: @@ -164,7 +167,7 @@ java -DskipFormModel=true This option will be helpful to skip model generation due to the form parameter, which is defined differently in OAS3 as there's no form parameter in OAS3 -### Ignore file format +## Ignore file format OpenAPI Generator supports a `.openapi-generator-ignore` file, similar to `.gitignore` or `.dockerignore` you're probably already familiar with. @@ -206,7 +209,7 @@ Upon first code generation, you may also pass the CLI option `--ignore-file-over Editor support for `.openapi-generator-ignore` files is available in IntelliJ via the [.ignore plugin](https://plugins.jetbrains.com/plugin/7495--ignore). -### Customizing the generator +## Customizing the generator There are different aspects of customizing the code generator beyond just creating or modifying templates. Each language has a supporting configuration file to handle different type mappings, etc: @@ -300,7 +303,7 @@ and specify the `classname` when running the generator: Your subclass will now be loaded and overrides the `PREFIX` value in the superclass. -### Bringing your own models +## Bringing your own models Sometimes you don't want a model generated. In this case, you can simply specify an import mapping to tell the codegen what _not_ to create. When doing this, every location that references a specific model will diff --git a/docs/faq.md b/docs/faq.md new file mode 100644 index 000000000000..73ba86771864 --- /dev/null +++ b/docs/faq.md @@ -0,0 +1,22 @@ +--- +id: faq +title: FAQ +--- + +## Do you have a chat room? + +[![Gitter](https://img.shields.io/gitter/room/:user/:repo.svg?style=for-the-badge)](https://gitter.im/OpenAPITools/openapi-generator) + +## What is the governance structure of the OpenAPI Generator project? + +OpenAPI generator (openapi-generator) is managed by the members of the [core team](./core-team.md). + +## What is the difference between Swagger Codegen and OpenAPI Generator? + +Swagger Codegen is driven by SmartBear while OpenAPI Generator is driven by the community. More than 40 top contributors and template creators of Swagger Codegen have joined OpenAPI Generator as the founding team members. For more details, see the [Fork Q&A](./qna.md). + +Swagger is a trademark owned by SmartBear and the use of the term "Swagger" in this project is for demo (reference) purposes only. + +## How do I extend the generator? + +See our [customization](./customization.md) documentation. \ No newline at end of file diff --git a/docs/generators.md b/docs/generators.md new file mode 100644 index 000000000000..2154b65fc034 --- /dev/null +++ b/docs/generators.md @@ -0,0 +1,126 @@ +--- +id: generators +title: Generators List +--- + +The following generators are available: + +## CLIENT generators +* [ada](generators/ada) +* [android](generators/android) +* [apex](generators/apex) +* [bash](generators/bash) +* [c](generators/c) +* [clojure](generators/clojure) +* [cpp-qt5-client](generators/cpp-qt5-client) +* [cpp-restsdk](generators/cpp-restsdk) +* [cpp-tizen](generators/cpp-tizen) +* [csharp](generators/csharp) +* [csharp-dotnet2](generators/csharp-dotnet2) +* [csharp-refactor](generators/csharp-refactor) +* [dart](generators/dart) +* [dart-jaguar](generators/dart-jaguar) +* [eiffel](generators/eiffel) +* [elixir](generators/elixir) +* [elm](generators/elm) +* [erlang-client](generators/erlang-client) +* [erlang-proper](generators/erlang-proper) +* [flash](generators/flash) +* [go](generators/go) +* [groovy](generators/groovy) +* [haskell-http-client](generators/haskell-http-client) +* [java](generators/java) +* [javascript](generators/javascript) +* [javascript-closure-angular](generators/javascript-closure-angular) +* [javascript-flowtyped](generators/javascript-flowtyped) +* [jaxrs-cxf-client](generators/jaxrs-cxf-client) +* [jmeter](generators/jmeter) +* [kotlin](generators/kotlin) +* [lua](generators/lua) +* [objc](generators/objc) +* [perl](generators/perl) +* [php](generators/php) +* [powershell](generators/powershell) +* [python](generators/python) +* [r](generators/r) +* [ruby](generators/ruby) +* [rust](generators/rust) +* [scala-akka](generators/scala-akka) +* [scala-gatling](generators/scala-gatling) +* [scala-httpclient](generators/scala-httpclient) +* [scalaz](generators/scalaz) +* [swift2-deprecated](generators/swift2-deprecated) +* [swift3-deprecated](generators/swift3-deprecated) +* [swift4](generators/swift4) +* [typescript-angular](generators/typescript-angular) +* [typescript-angularjs](generators/typescript-angularjs) +* [typescript-aurelia](generators/typescript-aurelia) +* [typescript-axios](generators/typescript-axios) +* [typescript-fetch](generators/typescript-fetch) +* [typescript-inversify](generators/typescript-inversify) +* [typescript-jquery](generators/typescript-jquery) +* [typescript-node](generators/typescript-node) + + +## SERVER generators +* [ada-server](generators/ada-server) +* [aspnetcore](generators/aspnetcore) +* [cpp-pistache-server](generators/cpp-pistache-server) +* [cpp-qt5-qhttpengine-server](generators/cpp-qt5-qhttpengine-server) +* [cpp-restbed-server](generators/cpp-restbed-server) +* [csharp-nancyfx](generators/csharp-nancyfx) +* [erlang-server](generators/erlang-server) +* [go-gin-server](generators/go-gin-server) +* [go-server](generators/go-server) +* [graphql-server](generators/graphql-server) +* [haskell](generators/haskell) +* [java-inflector](generators/java-inflector) +* [java-msf4j](generators/java-msf4j) +* [java-pkmst](generators/java-pkmst) +* [java-play-framework](generators/java-play-framework) +* [java-undertow-server](generators/java-undertow-server) +* [java-vertx](generators/java-vertx) +* [jaxrs-cxf](generators/jaxrs-cxf) +* [jaxrs-cxf-cdi](generators/jaxrs-cxf-cdi) +* [jaxrs-jersey](generators/jaxrs-jersey) +* [jaxrs-resteasy](generators/jaxrs-resteasy) +* [jaxrs-resteasy-eap](generators/jaxrs-resteasy-eap) +* [jaxrs-spec](generators/jaxrs-spec) +* [kotlin-server](generators/kotlin-server) +* [kotlin-spring](generators/kotlin-spring) +* [nodejs-server](generators/nodejs-server) +* [php-laravel](generators/php-laravel) +* [php-lumen](generators/php-lumen) +* [php-silex](generators/php-silex) +* [php-slim](generators/php-slim) +* [php-symfony](generators/php-symfony) +* [php-ze-ph](generators/php-ze-ph) +* [python-flask](generators/python-flask) +* [ruby-on-rails](generators/ruby-on-rails) +* [ruby-sinatra](generators/ruby-sinatra) +* [rust-server](generators/rust-server) +* [scala-finch](generators/scala-finch) +* [scala-lagom-server](generators/scala-lagom-server) +* [scalatra](generators/scalatra) +* [spring](generators/spring) + + +## DOCUMENTATION generators +* [cwiki](generators/cwiki) +* [dynamic-html](generators/dynamic-html) +* [html](generators/html) +* [html2](generators/html2) +* [openapi](generators/openapi) +* [openapi-yaml](generators/openapi-yaml) + + +## SCHEMA generators +* [mysql-schema](generators/mysql-schema) + + +## CONFIG generators +* [apache2](generators/apache2) +* [graphql-schema](generators/graphql-schema) + + + diff --git a/docs/generators/README.md b/docs/generators/README.md index 73a2d132d65d..79dff0e6defd 100644 --- a/docs/generators/README.md +++ b/docs/generators/README.md @@ -5,18 +5,21 @@ The following generators are available: - [android](android.md) - [apex](apex.md) - [bash](bash.md) + - [c](c.md) - [clojure](clojure.md) - - [cpp-qt5](cpp-qt5.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-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) @@ -42,7 +45,7 @@ The following generators are available: - [scala-httpclient](scala-httpclient.md) - [scalaz](scalaz.md) - [swift2-deprecated](swift2-deprecated.md) - - [swift3](swift3.md) + - [swift3-deprecated](swift3-deprecated.md) - [swift4](swift4.md) - [typescript-angular](typescript-angular.md) - [typescript-angularjs](typescript-angularjs.md) @@ -64,6 +67,7 @@ The following generators are available: - [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) @@ -111,6 +115,7 @@ The following generators are available: * CONFIG generators: - [apache2](apache2.md) + - [graphql-schema](graphql-schema.md) diff --git a/docs/generators/ada-server.md b/docs/generators/ada-server.md index 0cc253557025..a49975a36f40 100644 --- a/docs/generators/ada-server.md +++ b/docs/generators/ada-server.md @@ -1,19 +1,14 @@ -CONFIG OPTIONS for ada-server - - sortParamsByRequiredFlag - Sort method arguments to place required parameters before optional parameters. (Default: true) - - ensureUniqueParams - Whether to ensure parameter names are unique in an operation (rename parameters that are not). (Default: true) - - allowUnicodeIdentifiers - boolean, toggles whether unicode identifiers are allowed in names or not, default is false (Default: false) - - prependFormOrBodyParameters - Add form or body parameters to the beginning of the parameter list. (Default: false) - - projectName - GNAT project name (Default: defaultProject) - -Back to the [generators list](README.md) +--- +id: generator-opts-server-ada-server +title: Config Options for ada-server +sidebar_label: ada-server +--- + +| Option | Description | Values | Default | +| ------ | ----------- | ------ | ------- | +|sortParamsByRequiredFlag|Sort method arguments 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| +|prependFormOrBodyParameters|Add form or body parameters to the beginning of the parameter list.| |false| +|projectName|GNAT project name| |defaultProject| diff --git a/docs/generators/ada.md b/docs/generators/ada.md index d26a2a3a4920..ae6eb354c5be 100644 --- a/docs/generators/ada.md +++ b/docs/generators/ada.md @@ -1,19 +1,14 @@ -CONFIG OPTIONS for ada - - sortParamsByRequiredFlag - Sort method arguments to place required parameters before optional parameters. (Default: true) - - ensureUniqueParams - Whether to ensure parameter names are unique in an operation (rename parameters that are not). (Default: true) - - allowUnicodeIdentifiers - boolean, toggles whether unicode identifiers are allowed in names or not, default is false (Default: false) - - prependFormOrBodyParameters - Add form or body parameters to the beginning of the parameter list. (Default: false) - - projectName - GNAT project name (Default: defaultProject) - -Back to the [generators list](README.md) +--- +id: generator-opts-client-ada +title: Config Options for ada +sidebar_label: ada +--- + +| Option | Description | Values | Default | +| ------ | ----------- | ------ | ------- | +|sortParamsByRequiredFlag|Sort method arguments 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| +|prependFormOrBodyParameters|Add form or body parameters to the beginning of the parameter list.| |false| +|projectName|GNAT project name| |defaultProject| diff --git a/docs/generators/android.md b/docs/generators/android.md index 591cf0159dcc..e35957538f46 100644 --- a/docs/generators/android.md +++ b/docs/generators/android.md @@ -1,57 +1,26 @@ -CONFIG OPTIONS for android - - sortParamsByRequiredFlag - Sort method arguments to place required parameters before optional parameters. (Default: true) - - ensureUniqueParams - Whether to ensure parameter names are unique in an operation (rename parameters that are not). (Default: true) - - allowUnicodeIdentifiers - boolean, toggles whether unicode identifiers are allowed in names or not, default is false (Default: false) - - prependFormOrBodyParameters - Add form or body parameters to the beginning of the parameter list. (Default: false) - - modelPackage - package for generated models - - apiPackage - package for generated api classes - - invokerPackage - root package for generated code - - groupId - groupId for use in the generated build.gradle and pom.xml - - artifactId - artifactId for use in the generated build.gradle and pom.xml - - artifactVersion - artifact version for use in the generated build.gradle and pom.xml - - sourceFolder - source folder for generated code - - useAndroidMavenGradlePlugin - A flag to toggle android-maven gradle plugin. (Default: true) - - androidGradleVersion - gradleVersion version for use in the generated build.gradle - - androidSdkVersion - compileSdkVersion version for use in the generated build.gradle - - androidBuildToolsVersion - buildToolsVersion version for use in the generated build.gradle - - serializableModel - boolean - toggle "implements Serializable" for generated models (Default: false) - - library - library template (sub-template) to use - volley - HTTP client: Volley 1.0.19 (default) - httpclient - HTTP client: Apache HttpClient 4.3.6. JSON processing: Gson 2.3.1. IMPORTANT: Android client using HttpClient is not actively maintained and will be depecreated in the next major release. - -Back to the [generators list](README.md) +--- +id: generator-opts-client-android +title: Config Options for android +sidebar_label: android +--- + +| Option | Description | Values | Default | +| ------ | ----------- | ------ | ------- | +|sortParamsByRequiredFlag|Sort method arguments 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| +|prependFormOrBodyParameters|Add form or body parameters to the beginning of the parameter list.| |false| +|modelPackage|package for generated models| |null| +|apiPackage|package for generated api classes| |null| +|invokerPackage|root package for generated code| |null| +|groupId|groupId for use in the generated build.gradle and pom.xml| |null| +|artifactId|artifactId for use in the generated build.gradle and pom.xml| |null| +|artifactVersion|artifact version for use in the generated build.gradle and pom.xml| |null| +|sourceFolder|source folder for generated code| |null| +|useAndroidMavenGradlePlugin|A flag to toggle android-maven gradle plugin.| |true| +|androidGradleVersion|gradleVersion version for use in the generated build.gradle| |null| +|androidSdkVersion|compileSdkVersion version for use in the generated build.gradle| |null| +|androidBuildToolsVersion|buildToolsVersion version for use in the generated build.gradle| |null| +|serializableModel|boolean - toggle "implements Serializable" for generated models| |false| +|library|library template (sub-template) to use|
**volley**
HTTP client: Volley 1.0.19 (default)
**httpclient**
HTTP client: Apache HttpClient 4.3.6. JSON processing: Gson 2.3.1. IMPORTANT: Android client using HttpClient is not actively maintained and will be depecreated in the next major release.
|null| diff --git a/docs/generators/apache2.md b/docs/generators/apache2.md index da09b39bdda4..d85036b228bc 100644 --- a/docs/generators/apache2.md +++ b/docs/generators/apache2.md @@ -1,19 +1,14 @@ -CONFIG OPTIONS for apache2 - - sortParamsByRequiredFlag - Sort method arguments to place required parameters before optional parameters. (Default: true) - - ensureUniqueParams - Whether to ensure parameter names are unique in an operation (rename parameters that are not). (Default: true) - - allowUnicodeIdentifiers - boolean, toggles whether unicode identifiers are allowed in names or not, default is false (Default: false) - - prependFormOrBodyParameters - Add form or body parameters to the beginning of the parameter list. (Default: false) - - userInfoPath - Path to the user and group files - -Back to the [generators list](README.md) +--- +id: generator-opts-config-apache2 +title: Config Options for apache2 +sidebar_label: apache2 +--- + +| Option | Description | Values | Default | +| ------ | ----------- | ------ | ------- | +|sortParamsByRequiredFlag|Sort method arguments 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| +|prependFormOrBodyParameters|Add form or body parameters to the beginning of the parameter list.| |false| +|userInfoPath|Path to the user and group files| |null| diff --git a/docs/generators/apex.md b/docs/generators/apex.md index f9b7dd5b9bba..f90183b34a91 100644 --- a/docs/generators/apex.md +++ b/docs/generators/apex.md @@ -1,28 +1,17 @@ -CONFIG OPTIONS for apex - - sortParamsByRequiredFlag - Sort method arguments to place required parameters before optional parameters. (Default: true) - - ensureUniqueParams - Whether to ensure parameter names are unique in an operation (rename parameters that are not). (Default: true) - - allowUnicodeIdentifiers - boolean, toggles whether unicode identifiers are allowed in names or not, default is false (Default: false) - - prependFormOrBodyParameters - Add form or body parameters to the beginning of the parameter list. (Default: false) - - classPrefix - Prefix for generated classes. Set this to avoid overwriting existing classes in your org. - - apiVersion - The Metadata API version number to use for components in this package. - - buildMethod - The build method for this package. - - namedCredential - The named credential name for the HTTP callouts - -Back to the [generators list](README.md) +--- +id: generator-opts-client-apex +title: Config Options for apex +sidebar_label: apex +--- + +| Option | Description | Values | Default | +| ------ | ----------- | ------ | ------- | +|sortParamsByRequiredFlag|Sort method arguments 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| +|prependFormOrBodyParameters|Add form or body parameters to the beginning of the parameter list.| |false| +|classPrefix|Prefix for generated classes. Set this to avoid overwriting existing classes in your org.| |null| +|apiVersion|The Metadata API version number to use for components in this package.| |null| +|buildMethod|The build method for this package.| |null| +|namedCredential|The named credential name for the HTTP callouts| |null| diff --git a/docs/generators/aspnetcore.md b/docs/generators/aspnetcore.md index 1db6c0b3137b..07a55944c0f1 100644 --- a/docs/generators/aspnetcore.md +++ b/docs/generators/aspnetcore.md @@ -1,34 +1,19 @@ -CONFIG OPTIONS for aspnetcore - - packageName - C# package name (convention: Title.Case). (Default: Org.OpenAPITools) - - packageVersion - C# package version. (Default: 1.0.0) - - packageGuid - The GUID that will be associated with the C# project - - sourceFolder - source folder for generated code (Default: src) - - aspnetCoreVersion - ASP.NET Core version: 2.1 (default), 2.0 (deprecated) (Default: 2.1) - - sortParamsByRequiredFlag - Sort method arguments to place required parameters before optional parameters. (Default: true) - - useDateTimeOffset - Use DateTimeOffset to model date-time properties (Default: false) - - useCollection - Deserialize array types to Collection instead of List. (Default: false) - - returnICollection - Return ICollection instead of the concrete type. (Default: false) - - useSwashbuckle - Uses the Swashbuckle.AspNetCore NuGet package for documentation. (Default: true) - -Back to the [generators list](README.md) +--- +id: generator-opts-server-aspnetcore +title: Config Options for aspnetcore +sidebar_label: aspnetcore +--- + +| Option | Description | Values | Default | +| ------ | ----------- | ------ | ------- | +|packageName|C# package name (convention: Title.Case).| |Org.OpenAPITools| +|packageVersion|C# package version.| |1.0.0| +|packageGuid|The GUID that will be associated with the C# project| |null| +|sourceFolder|source folder for generated code| |src| +|aspnetCoreVersion|ASP.NET Core version: 2.1 (default), 2.0 (deprecated)| |2.1| +|sortParamsByRequiredFlag|Sort method arguments to place required parameters before optional parameters.| |true| +|useDateTimeOffset|Use DateTimeOffset to model date-time properties| |false| +|useCollection|Deserialize array types to Collection<T> instead of List<T>.| |false| +|returnICollection|Return ICollection<T> instead of the concrete type.| |false| +|useSwashbuckle|Uses the Swashbuckle.AspNetCore NuGet package for documentation.| |true| diff --git a/docs/generators/bash.md b/docs/generators/bash.md index 853512c85e03..4f8635935485 100644 --- a/docs/generators/bash.md +++ b/docs/generators/bash.md @@ -1,40 +1,21 @@ -CONFIG OPTIONS for bash - - sortParamsByRequiredFlag - Sort method arguments to place required parameters before optional parameters. (Default: true) - - ensureUniqueParams - Whether to ensure parameter names are unique in an operation (rename parameters that are not). (Default: true) - - allowUnicodeIdentifiers - boolean, toggles whether unicode identifiers are allowed in names or not, default is false (Default: false) - - prependFormOrBodyParameters - Add form or body parameters to the beginning of the parameter list. (Default: false) - - curlOptions - Default cURL options - - processMarkdown - Convert all Markdown Markup into terminal formatting (Default: false) - - scriptName - The name of the script that will be generated (e.g. petstore-cli) - - generateBashCompletion - Whether to generate the Bash completion script (Default: false) - - generateZshCompletion - Whether to generate the Zsh completion script (Default: false) - - hostEnvironmentVariable - Name of environment variable where host can be defined (e.g. PETSTORE_HOST='http://api.openapitools.org:8080') - - basicAuthEnvironmentVariable - Name of environment variable where username and password can be defined (e.g. PETSTORE_CREDS='username:password') - - apiKeyAuthEnvironmentVariable - Name of environment variable where API key can be defined (e.g. PETSTORE_APIKEY='kjhasdGASDa5asdASD') (Default: false) - -Back to the [generators list](README.md) +--- +id: generator-opts-client-bash +title: Config Options for bash +sidebar_label: bash +--- + +| Option | Description | Values | Default | +| ------ | ----------- | ------ | ------- | +|sortParamsByRequiredFlag|Sort method arguments 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| +|prependFormOrBodyParameters|Add form or body parameters to the beginning of the parameter list.| |false| +|curlOptions|Default cURL options| |null| +|processMarkdown|Convert all Markdown Markup into terminal formatting| |false| +|scriptName|The name of the script that will be generated (e.g. petstore-cli)| |null| +|generateBashCompletion|Whether to generate the Bash completion script| |false| +|generateZshCompletion|Whether to generate the Zsh completion script| |false| +|hostEnvironmentVariable|Name of environment variable where host can be defined (e.g. PETSTORE_HOST='http://api.openapitools.org:8080')| |null| +|basicAuthEnvironmentVariable|Name of environment variable where username and password can be defined (e.g. PETSTORE_CREDS='username:password')| |null| +|apiKeyAuthEnvironmentVariable|Name of environment variable where API key can be defined (e.g. PETSTORE_APIKEY='kjhasdGASDa5asdASD')| |false| diff --git a/docs/generators/c.md b/docs/generators/c.md new file mode 100644 index 000000000000..0a910b40d2a3 --- /dev/null +++ b/docs/generators/c.md @@ -0,0 +1,14 @@ + +--- +id: generator-opts-client-c +title: Config Options for c +sidebar_label: c +--- + +| Option | Description | Values | Default | +| ------ | ----------- | ------ | ------- | +|sortParamsByRequiredFlag|Sort method arguments 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| +|prependFormOrBodyParameters|Add form or body parameters to the beginning of the parameter list.| |false| +|hideGenerationTimestamp|Hides the generation timestamp when files are generated.| |true| diff --git a/docs/generators/clojure.md b/docs/generators/clojure.md index 55bc7facb49f..239b3b441418 100644 --- a/docs/generators/clojure.md +++ b/docs/generators/clojure.md @@ -1,37 +1,20 @@ -CONFIG OPTIONS for clojure - - sortParamsByRequiredFlag - Sort method arguments to place required parameters before optional parameters. (Default: true) - - ensureUniqueParams - Whether to ensure parameter names are unique in an operation (rename parameters that are not). (Default: true) - - allowUnicodeIdentifiers - boolean, toggles whether unicode identifiers are allowed in names or not, default is false (Default: false) - - prependFormOrBodyParameters - Add form or body parameters to the beginning of the parameter list. (Default: false) - - projectName - name of the project (Default: generated from info.title or "openapi-clj-client") - - projectDescription - description of the project (Default: using info.description or "Client library of ") - - projectVersion - version of the project (Default: using info.version or "1.0.0") - - projectUrl - URL of the project (Default: using info.contact.url or not included in project.clj) - - projectLicenseName - name of the license the project uses (Default: using info.license.name or not included in project.clj) - - projectLicenseUrl - URL of the license the project uses (Default: using info.license.url or not included in project.clj) - - baseNamespace - the base/top namespace (Default: generated from projectName) - -Back to the [generators list](README.md) +--- +id: generator-opts-client-clojure +title: Config Options for clojure +sidebar_label: clojure +--- + +| Option | Description | Values | Default | +| ------ | ----------- | ------ | ------- | +|sortParamsByRequiredFlag|Sort method arguments 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| +|prependFormOrBodyParameters|Add form or body parameters to the beginning of the parameter list.| |false| +|projectName|name of the project (Default: generated from info.title or "openapi-clj-client")| |null| +|projectDescription|description of the project (Default: using info.description or "Client library of <projectName>")| |null| +|projectVersion|version of the project (Default: using info.version or "1.0.0")| |null| +|projectUrl|URL of the project (Default: using info.contact.url or not included in project.clj)| |null| +|projectLicenseName|name of the license the project uses (Default: using info.license.name or not included in project.clj)| |null| +|projectLicenseUrl|URL of the license the project uses (Default: using info.license.url or not included in project.clj)| |null| +|baseNamespace|the base/top namespace (Default: generated from projectName)| |null| diff --git a/docs/generators/cpp-pistache-server.md b/docs/generators/cpp-pistache-server.md index 52f9ed18c178..ac4abee691e6 100644 --- a/docs/generators/cpp-pistache-server.md +++ b/docs/generators/cpp-pistache-server.md @@ -1,10 +1,11 @@ -CONFIG OPTIONS for cpp-pistache-server - - addExternalLibs - Add the Possibility to fetch and compile external Libraries needed by this Framework. (Default: true) - - helpersPackage - Specify the package name to be used for the helpers (e.g. org.openapitools.server.helpers). (Default: org.openapitools.server.helpers) - -Back to the [generators list](README.md) +--- +id: generator-opts-server-cpp-pistache-server +title: Config Options for cpp-pistache-server +sidebar_label: cpp-pistache-server +--- + +| Option | Description | Values | Default | +| ------ | ----------- | ------ | ------- | +|addExternalLibs|Add the Possibility to fetch and compile external Libraries needed by this Framework.| |true| +|helpersPackage|Specify the package name to be used for the helpers (e.g. org.openapitools.server.helpers).| |org.openapitools.server.helpers| diff --git a/docs/generators/cpp-qt5-client.md b/docs/generators/cpp-qt5-client.md new file mode 100644 index 000000000000..8c72f0bedd60 --- /dev/null +++ b/docs/generators/cpp-qt5-client.md @@ -0,0 +1,16 @@ + +--- +id: generator-opts-client-cpp-qt5-client +title: Config Options for cpp-qt5-client +sidebar_label: cpp-qt5-client +--- + +| Option | Description | Values | Default | +| ------ | ----------- | ------ | ------- | +|sortParamsByRequiredFlag|Sort method arguments 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| +|prependFormOrBodyParameters|Add form or body parameters to the beginning of the parameter list.| |false| +|cppNamespace|C++ namespace (convention: name::space::for::api).| |OpenAPI| +|cppNamespace|C++ namespace (convention: name::space::for::api).| |OpenAPI| +|optionalProjectFile|Generate client.pri.| |true| diff --git a/docs/generators/cpp-qt5-qhttpengine-server.md b/docs/generators/cpp-qt5-qhttpengine-server.md index 27f369c81fff..364066a0d82c 100644 --- a/docs/generators/cpp-qt5-qhttpengine-server.md +++ b/docs/generators/cpp-qt5-qhttpengine-server.md @@ -1,22 +1,15 @@ -CONFIG OPTIONS for cpp-qt5-qhttpengine-server - - sortParamsByRequiredFlag - Sort method arguments to place required parameters before optional parameters. (Default: true) - - ensureUniqueParams - Whether to ensure parameter names are unique in an operation (rename parameters that are not). (Default: true) - - allowUnicodeIdentifiers - boolean, toggles whether unicode identifiers are allowed in names or not, default is false (Default: false) - - prependFormOrBodyParameters - Add form or body parameters to the beginning of the parameter list. (Default: false) - - cppNamespace - C++ namespace (convention: name::space::for::api). (Default: OpenAPI) - - cppNamespace - C++ namespace (convention: name::space::for::api). (Default: OpenAPI) - -Back to the [generators list](README.md) +--- +id: generator-opts-server-cpp-qt5-qhttpengine-server +title: Config Options for cpp-qt5-qhttpengine-server +sidebar_label: cpp-qt5-qhttpengine-server +--- + +| Option | Description | Values | Default | +| ------ | ----------- | ------ | ------- | +|sortParamsByRequiredFlag|Sort method arguments 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| +|prependFormOrBodyParameters|Add form or body parameters to the beginning of the parameter list.| |false| +|cppNamespace|C++ namespace (convention: name::space::for::api).| |OpenAPI| +|cppNamespace|C++ namespace (convention: name::space::for::api).| |OpenAPI| diff --git a/docs/generators/cpp-qt5.md b/docs/generators/cpp-qt5.md deleted file mode 100644 index 924187fc8e4e..000000000000 --- a/docs/generators/cpp-qt5.md +++ /dev/null @@ -1,22 +0,0 @@ - -CONFIG OPTIONS for cpp-qt5 - - sortParamsByRequiredFlag - Sort method arguments to place required parameters before optional parameters. (Default: true) - - ensureUniqueParams - Whether to ensure parameter names are unique in an operation (rename parameters that are not). (Default: true) - - allowUnicodeIdentifiers - boolean, toggles whether unicode identifiers are allowed in names or not, default is false (Default: false) - - prependFormOrBodyParameters - Add form or body parameters to the beginning of the parameter list. (Default: false) - - cppNamespace - C++ namespace (convention: name::space::for::api). (Default: OpenAPI) - - optionalProjectFile - Generate client.pri. (Default: true) - -Back to the [generators list](README.md) diff --git a/docs/generators/cpp-restbed-server.md b/docs/generators/cpp-restbed-server.md index 0ef5dfddf051..d5afa990cfb7 100644 --- a/docs/generators/cpp-restbed-server.md +++ b/docs/generators/cpp-restbed-server.md @@ -1,19 +1,14 @@ -CONFIG OPTIONS for cpp-restbed-server - - modelPackage - C++ namespace for models (convention: name.space.model). (Default: org.openapitools.server.model) - - apiPackage - C++ namespace for apis (convention: name.space.api). (Default: org.openapitools.server.api) - - packageVersion - C++ package version. (Default: 1.0.0) - - declspec - C++ preprocessor to place before the class name for handling dllexport/dllimport. (Default: ) - - defaultInclude - The default include statement that should be placed in all headers for including things like the declspec (convention: #include "Commons.h" (Default: ) - -Back to the [generators list](README.md) +--- +id: generator-opts-server-cpp-restbed-server +title: Config Options for cpp-restbed-server +sidebar_label: cpp-restbed-server +--- + +| Option | Description | Values | Default | +| ------ | ----------- | ------ | ------- | +|modelPackage|C++ namespace for models (convention: name.space.model).| |org.openapitools.server.model| +|apiPackage|C++ namespace for apis (convention: name.space.api).| |org.openapitools.server.api| +|packageVersion|C++ package version.| |1.0.0| +|declspec|C++ preprocessor to place before the class name for handling dllexport/dllimport.| || +|defaultInclude|The default include statement that should be placed in all headers for including things like the declspec (convention: #include "Commons.h" | || diff --git a/docs/generators/cpp-restsdk.md b/docs/generators/cpp-restsdk.md index 9ada7842d0d1..1ff8eeafce07 100644 --- a/docs/generators/cpp-restsdk.md +++ b/docs/generators/cpp-restsdk.md @@ -1,22 +1,15 @@ -CONFIG OPTIONS for cpp-restsdk - - modelPackage - C++ namespace for models (convention: name.space.model). (Default: org.openapitools.client.model) - - apiPackage - C++ namespace for apis (convention: name.space.api). (Default: org.openapitools.client.api) - - packageVersion - C++ package version. (Default: 1.0.0) - - declspec - C++ preprocessor to place before the class name for handling dllexport/dllimport. (Default: ) - - defaultInclude - The default include statement that should be placed in all headers for including things like the declspec (convention: #include "Commons.h" (Default: ) - - generateGMocksForApis - Generate Google Mock classes for APIs. - -Back to the [generators list](README.md) +--- +id: generator-opts-client-cpp-restsdk +title: Config Options for cpp-restsdk +sidebar_label: cpp-restsdk +--- + +| Option | Description | Values | Default | +| ------ | ----------- | ------ | ------- | +|modelPackage|C++ namespace for models (convention: name.space.model).| |org.openapitools.client.model| +|apiPackage|C++ namespace for apis (convention: name.space.api).| |org.openapitools.client.api| +|packageVersion|C++ package version.| |1.0.0| +|declspec|C++ preprocessor to place before the class name for handling dllexport/dllimport.| || +|defaultInclude|The default include statement that should be placed in all headers for including things like the declspec (convention: #include "Commons.h" | || +|generateGMocksForApis|Generate Google Mock classes for APIs.| |null| diff --git a/docs/generators/cpp-tizen.md b/docs/generators/cpp-tizen.md index a9f5e3db24fb..aaf57194b8a5 100644 --- a/docs/generators/cpp-tizen.md +++ b/docs/generators/cpp-tizen.md @@ -1,16 +1,13 @@ -CONFIG OPTIONS for cpp-tizen - - sortParamsByRequiredFlag - Sort method arguments to place required parameters before optional parameters. (Default: true) - - ensureUniqueParams - Whether to ensure parameter names are unique in an operation (rename parameters that are not). (Default: true) - - allowUnicodeIdentifiers - boolean, toggles whether unicode identifiers are allowed in names or not, default is false (Default: false) - - prependFormOrBodyParameters - Add form or body parameters to the beginning of the parameter list. (Default: false) - -Back to the [generators list](README.md) +--- +id: generator-opts-client-cpp-tizen +title: Config Options for cpp-tizen +sidebar_label: cpp-tizen +--- + +| Option | Description | Values | Default | +| ------ | ----------- | ------ | ------- | +|sortParamsByRequiredFlag|Sort method arguments 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| +|prependFormOrBodyParameters|Add form or body parameters to the beginning of the parameter list.| |false| diff --git a/docs/generators/csharp-dotnet2.md b/docs/generators/csharp-dotnet2.md index 79ce829f9c2d..319b2b190f59 100644 --- a/docs/generators/csharp-dotnet2.md +++ b/docs/generators/csharp-dotnet2.md @@ -1,13 +1,12 @@ -CONFIG OPTIONS for csharp-dotnet2 - - packageName - C# package name (convention: Camel.Case). (Default: Org.OpenAPITools) - - packageVersion - C# package version. (Default: 1.0.0) - - clientPackage - C# client package name (convention: Camel.Case). (Default: Org.OpenAPITools.Client) - -Back to the [generators list](README.md) +--- +id: generator-opts-client-csharp-dotnet2 +title: Config Options for csharp-dotnet2 +sidebar_label: csharp-dotnet2 +--- + +| Option | Description | Values | Default | +| ------ | ----------- | ------ | ------- | +|packageName|C# package name (convention: Camel.Case).| |Org.OpenAPITools| +|packageVersion|C# package version.| |1.0.0| +|clientPackage|C# client package name (convention: Camel.Case).| |Org.OpenAPITools.Client| diff --git a/docs/generators/csharp-nancyfx.md b/docs/generators/csharp-nancyfx.md index 209951d9f2df..69d0504926e2 100644 --- a/docs/generators/csharp-nancyfx.md +++ b/docs/generators/csharp-nancyfx.md @@ -1,46 +1,23 @@ -CONFIG OPTIONS for csharp-nancyfx - - packageName - C# package name (convention: Title.Case). (Default: Org.OpenAPITools) - - packageVersion - C# package version. (Default: 1.0.0) - - sourceFolder - source folder for generated code (Default: src) - - interfacePrefix - Prefix interfaces with a community standard or widely accepted prefix. (Default: ) - - packageGuid - The GUID that will be associated with the C# project - - packageContext - Optionally overrides the PackageContext which determines the namespace (namespace=packageName.packageContext). If not set, packageContext will default to basePath. - - sortParamsByRequiredFlag - Sort method arguments to place required parameters before optional parameters. (Default: true) - - optionalProjectFile - Generate {PackageName}.csproj. (Default: true) - - useDateTimeOffset - Use DateTimeOffset to model date-time properties (Default: false) - - useCollection - Deserialize array types to Collection instead of List. (Default: false) - - returnICollection - Return ICollection instead of the concrete type. (Default: false) - - immutable - Enabled by default. If disabled generates model classes with setters (Default: true) - - writeModulePath - Enabled by default. If disabled, module paths will not mirror api base path (Default: true) - - asyncServer - Set to true to enable the generation of async routes/endpoints. (Default: false) - -Back to the [generators list](README.md) +--- +id: generator-opts-server-csharp-nancyfx +title: Config Options for csharp-nancyfx +sidebar_label: csharp-nancyfx +--- + +| Option | Description | Values | Default | +| ------ | ----------- | ------ | ------- | +|packageName|C# package name (convention: Title.Case).| |Org.OpenAPITools| +|packageVersion|C# package version.| |1.0.0| +|sourceFolder|source folder for generated code| |src| +|interfacePrefix|Prefix interfaces with a community standard or widely accepted prefix.| || +|packageGuid|The GUID that will be associated with the C# project| |null| +|packageContext|Optionally overrides the PackageContext which determines the namespace (namespace=packageName.packageContext). If not set, packageContext will default to basePath.| |null| +|sortParamsByRequiredFlag|Sort method arguments to place required parameters before optional parameters.| |true| +|optionalProjectFile|Generate {PackageName}.csproj.| |true| +|useDateTimeOffset|Use DateTimeOffset to model date-time properties| |false| +|useCollection|Deserialize array types to Collection<T> instead of List<T>.| |false| +|returnICollection|Return ICollection<T> instead of the concrete type.| |false| +|immutable|Enabled by default. If disabled generates model classes with setters| |true| +|writeModulePath|Enabled by default. If disabled, module paths will not mirror api base path| |true| +|asyncServer|Set to true to enable the generation of async routes/endpoints.| |false| diff --git a/docs/generators/csharp-refactor.md b/docs/generators/csharp-refactor.md new file mode 100644 index 000000000000..34c55c16390c --- /dev/null +++ b/docs/generators/csharp-refactor.md @@ -0,0 +1,30 @@ + +--- +id: generator-opts-client-csharp-refactor +title: Config Options for csharp-refactor +sidebar_label: csharp-refactor +--- + +| Option | Description | Values | Default | +| ------ | ----------- | ------ | ------- | +|packageName|C# package name (convention: Title.Case).| |Org.OpenAPITools| +|packageVersion|C# package version.| |1.0.0| +|sourceFolder|source folder for generated code| |src| +|packageGuid|The GUID that will be associated with the C# project| |null| +|interfacePrefix|Prefix interfaces with a community standard or widely accepted prefix.| |I| +|targetFramework|The target .NET framework version.|
**v3.5**
.NET Framework 3.5 compatible
**v4.0**
.NET Framework 4.0 compatible
**v4.5.2**
.NET Framework 4.5.2+ compatible
**v5.0**
.NET Standard 1.3 compatible
**uwp**
Universal Windows Platform (IMPORTANT: this will be decommissioned and replaced by v5.0)
|v4.5.2| +|modelPropertyNaming|Naming convention for the property: 'camelCase', 'PascalCase', 'snake_case' and 'original', which keeps the original name| |PascalCase| +|hideGenerationTimestamp|Hides the generation timestamp when files are generated.| |true| +|sortParamsByRequiredFlag|Sort method arguments to place required parameters before optional parameters.| |true| +|useDateTimeOffset|Use DateTimeOffset to model date-time properties| |false| +|useCollection|Deserialize array types to Collection<T> instead of List<T>.| |false| +|returnICollection|Return ICollection<T> instead of the concrete type.| |false| +|optionalMethodArgument|C# Optional method argument, e.g. void square(int x=10) (.net 4.0+ only).| |true| +|optionalAssemblyInfo|Generate AssemblyInfo.cs.| |true| +|optionalProjectFile|Generate {PackageName}.csproj.| |true| +|optionalEmitDefaultValues|Set DataMember's EmitDefaultValue.| |false| +|generatePropertyChanged|Specifies a AssemblyDescription for the .NET Framework global assembly attributes stored in the AssemblyInfo file.| |false| +|nonPublicApi|Generates code with reduced access modifiers; allows embedding elsewhere without exposing non-public API calls to consumers.| |false| +|allowUnicodeIdentifiers|boolean, toggles whether unicode identifiers are allowed in names or not, default is false| |false| +|netCoreProjectFile|Use the new format (.NET Core) for .NET project files (.csproj).| |false| +|validatable|Generates self-validatable models.| |true| diff --git a/docs/generators/csharp.md b/docs/generators/csharp.md index 4cf223a515e1..3ff6a13fc79b 100644 --- a/docs/generators/csharp.md +++ b/docs/generators/csharp.md @@ -1,72 +1,30 @@ -CONFIG OPTIONS for csharp - - packageName - C# package name (convention: Title.Case). (Default: Org.OpenAPITools) - - packageVersion - C# package version. (Default: 1.0.0) - - sourceFolder - source folder for generated code (Default: src) - - packageGuid - The GUID that will be associated with the C# project - - interfacePrefix - Prefix interfaces with a community standard or widely accepted prefix. (Default: I) - - targetFramework - The target .NET framework version. (Default: v4.5) - v3.5 - .NET Framework 3.5 compatible - v4.0 - .NET Framework 4.0 compatible - v4.5 - .NET Framework 4.5+ compatible - v5.0 - .NET Standard 1.3 compatible - uwp - Universal Windows Platform (IMPORTANT: this will be decommissioned and replaced by v5.0) - - modelPropertyNaming - Naming convention for the property: 'camelCase', 'PascalCase', 'snake_case' and 'original', which keeps the original name (Default: PascalCase) - - hideGenerationTimestamp - Hides the generation timestamp when files are generated. (Default: true) - - sortParamsByRequiredFlag - Sort method arguments to place required parameters before optional parameters. (Default: true) - - useDateTimeOffset - Use DateTimeOffset to model date-time properties (Default: false) - - useCollection - Deserialize array types to Collection instead of List. (Default: false) - - returnICollection - Return ICollection instead of the concrete type. (Default: false) - - optionalMethodArgument - C# Optional method argument, e.g. void square(int x=10) (.net 4.0+ only). (Default: true) - - optionalAssemblyInfo - Generate AssemblyInfo.cs. (Default: true) - - optionalProjectFile - Generate {PackageName}.csproj. (Default: true) - - optionalEmitDefaultValues - Set DataMember's EmitDefaultValue. (Default: false) - - generatePropertyChanged - Specifies a AssemblyDescription for the .NET Framework global assembly attributes stored in the AssemblyInfo file. (Default: false) - - nonPublicApi - Generates code with reduced access modifiers; allows embedding elsewhere without exposing non-public API calls to consumers. (Default: false) - - allowUnicodeIdentifiers - boolean, toggles whether unicode identifiers are allowed in names or not, default is false (Default: false) - - netCoreProjectFile - Use the new format (.NET Core) for .NET project files (.csproj). (Default: false) - - validatable - Generates self-validatable models. (Default: true) - -Back to the [generators list](README.md) +--- +id: generator-opts-client-csharp +title: Config Options for csharp +sidebar_label: csharp +--- + +| Option | Description | Values | Default | +| ------ | ----------- | ------ | ------- | +|packageName|C# package name (convention: Title.Case).| |Org.OpenAPITools| +|packageVersion|C# package version.| |1.0.0| +|sourceFolder|source folder for generated code| |src| +|packageGuid|The GUID that will be associated with the C# project| |null| +|interfacePrefix|Prefix interfaces with a community standard or widely accepted prefix.| |I| +|targetFramework|The target .NET framework version.|
**v3.5**
.NET Framework 3.5 compatible
**v4.0**
.NET Framework 4.0 compatible
**v4.5**
.NET Framework 4.5+ compatible
**v5.0**
.NET Standard 1.3 compatible
**uwp**
Universal Windows Platform (IMPORTANT: this will be decommissioned and replaced by v5.0)
|v4.5| +|modelPropertyNaming|Naming convention for the property: 'camelCase', 'PascalCase', 'snake_case' and 'original', which keeps the original name| |PascalCase| +|hideGenerationTimestamp|Hides the generation timestamp when files are generated.| |true| +|sortParamsByRequiredFlag|Sort method arguments to place required parameters before optional parameters.| |true| +|useDateTimeOffset|Use DateTimeOffset to model date-time properties| |false| +|useCollection|Deserialize array types to Collection<T> instead of List<T>.| |false| +|returnICollection|Return ICollection<T> instead of the concrete type.| |false| +|optionalMethodArgument|C# Optional method argument, e.g. void square(int x=10) (.net 4.0+ only).| |true| +|optionalAssemblyInfo|Generate AssemblyInfo.cs.| |true| +|optionalProjectFile|Generate {PackageName}.csproj.| |true| +|optionalEmitDefaultValues|Set DataMember's EmitDefaultValue.| |false| +|generatePropertyChanged|Specifies a AssemblyDescription for the .NET Framework global assembly attributes stored in the AssemblyInfo file.| |false| +|nonPublicApi|Generates code with reduced access modifiers; allows embedding elsewhere without exposing non-public API calls to consumers.| |false| +|allowUnicodeIdentifiers|boolean, toggles whether unicode identifiers are allowed in names or not, default is false| |false| +|netCoreProjectFile|Use the new format (.NET Core) for .NET project files (.csproj).| |false| +|validatable|Generates self-validatable models.| |true| diff --git a/docs/generators/cwiki.md b/docs/generators/cwiki.md index 3af892ada70e..e809a2161c92 100644 --- a/docs/generators/cwiki.md +++ b/docs/generators/cwiki.md @@ -1,46 +1,23 @@ -CONFIG OPTIONS for cwiki - - sortParamsByRequiredFlag - Sort method arguments to place required parameters before optional parameters. (Default: true) - - ensureUniqueParams - Whether to ensure parameter names are unique in an operation (rename parameters that are not). (Default: true) - - allowUnicodeIdentifiers - boolean, toggles whether unicode identifiers are allowed in names or not, default is false (Default: false) - - prependFormOrBodyParameters - Add form or body parameters to the beginning of the parameter list. (Default: false) - - appName - short name of the application - - appDescription - description of the application - - infoUrl - a URL where users can get more information about the application - - infoEmail - an email address to contact for inquiries about the application - - licenseInfo - a short description of the license - - licenseUrl - a URL pointing to the full license - - invokerPackage - root package for generated code - - groupId - groupId in generated pom.xml - - artifactId - artifactId in generated pom.xml - - artifactVersion - artifact version in generated pom.xml - -Back to the [generators list](README.md) +--- +id: generator-opts-documentation-cwiki +title: Config Options for cwiki +sidebar_label: cwiki +--- + +| Option | Description | Values | Default | +| ------ | ----------- | ------ | ------- | +|sortParamsByRequiredFlag|Sort method arguments 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| +|prependFormOrBodyParameters|Add form or body parameters to the beginning of the parameter list.| |false| +|appName|short name of the application| |null| +|appDescription|description of the application| |null| +|infoUrl|a URL where users can get more information about the application| |null| +|infoEmail|an email address to contact for inquiries about the application| |null| +|licenseInfo|a short description of the license| |null| +|licenseUrl|a URL pointing to the full license| |null| +|invokerPackage|root package for generated code| |null| +|groupId|groupId in generated pom.xml| |null| +|artifactId|artifactId in generated pom.xml| |null| +|artifactVersion|artifact version in generated pom.xml| |null| diff --git a/docs/generators/dart-jaguar.md b/docs/generators/dart-jaguar.md index 5d9eb6304cf8..eb6fe782989b 100644 --- a/docs/generators/dart-jaguar.md +++ b/docs/generators/dart-jaguar.md @@ -1,40 +1,21 @@ -CONFIG OPTIONS for dart-jaguar - - sortParamsByRequiredFlag - Sort method arguments to place required parameters before optional parameters. (Default: true) - - ensureUniqueParams - Whether to ensure parameter names are unique in an operation (rename parameters that are not). (Default: true) - - allowUnicodeIdentifiers - boolean, toggles whether unicode identifiers are allowed in names or not, default is false (Default: false) - - prependFormOrBodyParameters - Add form or body parameters to the beginning of the parameter list. (Default: false) - - browserClient - Is the client browser based - - pubName - Name in generated pubspec - - pubVersion - Version in generated pubspec - - pubDescription - Description in generated pubspec - - useEnumExtension - Allow the 'x-enum-values' extension for enums - - sourceFolder - source folder for generated code - - supportDart2 - support dart2 (Default: true) - - nullableFields - Is the null fields should be in the JSON payload - -Back to the [generators list](README.md) +--- +id: generator-opts-client-dart-jaguar +title: Config Options for dart-jaguar +sidebar_label: dart-jaguar +--- + +| Option | Description | Values | Default | +| ------ | ----------- | ------ | ------- | +|sortParamsByRequiredFlag|Sort method arguments 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| +|prependFormOrBodyParameters|Add form or body parameters to the beginning of the parameter list.| |false| +|browserClient|Is the client browser based| |null| +|pubName|Name in generated pubspec| |null| +|pubVersion|Version in generated pubspec| |null| +|pubDescription|Description in generated pubspec| |null| +|useEnumExtension|Allow the 'x-enum-values' extension for enums| |null| +|sourceFolder|source folder for generated code| |null| +|supportDart2|support dart2| |true| +|nullableFields|Is the null fields should be in the JSON payload| |null| diff --git a/docs/generators/dart.md b/docs/generators/dart.md index 3e552468305a..52e6bd7e73b0 100644 --- a/docs/generators/dart.md +++ b/docs/generators/dart.md @@ -1,37 +1,20 @@ -CONFIG OPTIONS for dart - - sortParamsByRequiredFlag - Sort method arguments to place required parameters before optional parameters. (Default: true) - - ensureUniqueParams - Whether to ensure parameter names are unique in an operation (rename parameters that are not). (Default: true) - - allowUnicodeIdentifiers - boolean, toggles whether unicode identifiers are allowed in names or not, default is false (Default: false) - - prependFormOrBodyParameters - Add form or body parameters to the beginning of the parameter list. (Default: false) - - browserClient - Is the client browser based - - pubName - Name in generated pubspec - - pubVersion - Version in generated pubspec - - pubDescription - Description in generated pubspec - - useEnumExtension - Allow the 'x-enum-values' extension for enums - - sourceFolder - source folder for generated code - - supportDart2 - support dart2 (Default: true) - -Back to the [generators list](README.md) +--- +id: generator-opts-client-dart +title: Config Options for dart +sidebar_label: dart +--- + +| Option | Description | Values | Default | +| ------ | ----------- | ------ | ------- | +|sortParamsByRequiredFlag|Sort method arguments 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| +|prependFormOrBodyParameters|Add form or body parameters to the beginning of the parameter list.| |false| +|browserClient|Is the client browser based| |null| +|pubName|Name in generated pubspec| |null| +|pubVersion|Version in generated pubspec| |null| +|pubDescription|Description in generated pubspec| |null| +|useEnumExtension|Allow the 'x-enum-values' extension for enums| |null| +|sourceFolder|source folder for generated code| |null| +|supportDart2|support dart2| |true| diff --git a/docs/generators/dynamic-html.md b/docs/generators/dynamic-html.md index e6f20ff0247b..1c62db6e2312 100644 --- a/docs/generators/dynamic-html.md +++ b/docs/generators/dynamic-html.md @@ -1,28 +1,17 @@ -CONFIG OPTIONS for dynamic-html - - sortParamsByRequiredFlag - Sort method arguments to place required parameters before optional parameters. (Default: true) - - ensureUniqueParams - Whether to ensure parameter names are unique in an operation (rename parameters that are not). (Default: true) - - allowUnicodeIdentifiers - boolean, toggles whether unicode identifiers are allowed in names or not, default is false (Default: false) - - prependFormOrBodyParameters - Add form or body parameters to the beginning of the parameter list. (Default: false) - - invokerPackage - root package for generated code - - groupId - groupId in generated pom.xml - - artifactId - artifactId in generated pom.xml - - artifactVersion - artifact version in generated pom.xml - -Back to the [generators list](README.md) +--- +id: generator-opts-documentation-dynamic-html +title: Config Options for dynamic-html +sidebar_label: dynamic-html +--- + +| Option | Description | Values | Default | +| ------ | ----------- | ------ | ------- | +|sortParamsByRequiredFlag|Sort method arguments 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| +|prependFormOrBodyParameters|Add form or body parameters to the beginning of the parameter list.| |false| +|invokerPackage|root package for generated code| |null| +|groupId|groupId in generated pom.xml| |null| +|artifactId|artifactId in generated pom.xml| |null| +|artifactVersion|artifact version in generated pom.xml| |null| diff --git a/docs/generators/eiffel.md b/docs/generators/eiffel.md index 5c806df6adcd..9f3a27dca16b 100644 --- a/docs/generators/eiffel.md +++ b/docs/generators/eiffel.md @@ -1,13 +1,12 @@ -CONFIG OPTIONS for eiffel - - packageName - Eiffel Cluster name (convention: lowercase). (Default: openapi) - - packageVersion - Eiffel package version. (Default: 1.0.0) - - hideGenerationTimestamp - Hides the generation timestamp when files are generated. (Default: true) - -Back to the [generators list](README.md) +--- +id: generator-opts-client-eiffel +title: Config Options for eiffel +sidebar_label: eiffel +--- + +| Option | Description | Values | Default | +| ------ | ----------- | ------ | ------- | +|packageName|Eiffel Cluster name (convention: lowercase).| |openapi| +|packageVersion|Eiffel package version.| |1.0.0| +|hideGenerationTimestamp|Hides the generation timestamp when files are generated.| |true| diff --git a/docs/generators/elixir.md b/docs/generators/elixir.md index 92dad5e3c0e3..bcf7e8ccf2de 100644 --- a/docs/generators/elixir.md +++ b/docs/generators/elixir.md @@ -1,25 +1,16 @@ -CONFIG OPTIONS for elixir - - sortParamsByRequiredFlag - Sort method arguments to place required parameters before optional parameters. (Default: true) - - ensureUniqueParams - Whether to ensure parameter names are unique in an operation (rename parameters that are not). (Default: true) - - allowUnicodeIdentifiers - boolean, toggles whether unicode identifiers are allowed in names or not, default is false (Default: false) - - prependFormOrBodyParameters - Add form or body parameters to the beginning of the parameter list. (Default: false) - - invokerPackage - The main namespace to use for all classes. e.g. Yay.Pets - - licenseHeader - The license header to prepend to the top of all source files. - - packageName - Elixir package name (convention: lowercase). - -Back to the [generators list](README.md) +--- +id: generator-opts-client-elixir +title: Config Options for elixir +sidebar_label: elixir +--- + +| Option | Description | Values | Default | +| ------ | ----------- | ------ | ------- | +|sortParamsByRequiredFlag|Sort method arguments 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| +|prependFormOrBodyParameters|Add form or body parameters to the beginning of the parameter list.| |false| +|invokerPackage|The main namespace to use for all classes. e.g. Yay.Pets| |null| +|licenseHeader|The license header to prepend to the top of all source files.| |null| +|packageName|Elixir package name (convention: lowercase).| |null| diff --git a/docs/generators/elm.md b/docs/generators/elm.md index 65044602159f..2782d13e9ff9 100644 --- a/docs/generators/elm.md +++ b/docs/generators/elm.md @@ -1,18 +1,13 @@ -CONFIG OPTIONS for elm - - elmVersion - Elm version: 0.18, 0.19 (Default: 0.19) - 0.19 - Elm 0.19 - 0.18 - Elm 0.18 - - elmPrefixCustomTypeVariants - Prefix custom type variants (Default: false) - - elmEnableCustomBasePaths - Enable setting the base path for each request (Default: false) - - elmEnableHttpRequestTrackers - Enable adding a tracker to each http request (Default: false) - -Back to the [generators list](README.md) +--- +id: generator-opts-client-elm +title: Config Options for elm +sidebar_label: elm +--- + +| Option | Description | Values | Default | +| ------ | ----------- | ------ | ------- | +|elmVersion|Elm version: 0.18, 0.19|
**0.19**
Elm 0.19
**0.18**
Elm 0.18
|0.19| +|elmPrefixCustomTypeVariants|Prefix custom type variants| |false| +|elmEnableCustomBasePaths|Enable setting the base path for each request| |false| +|elmEnableHttpRequestTrackers|Enable adding a tracker to each http request| |false| diff --git a/docs/generators/erlang-client.md b/docs/generators/erlang-client.md index e3a2aa7ce693..7ff4cd412842 100644 --- a/docs/generators/erlang-client.md +++ b/docs/generators/erlang-client.md @@ -1,10 +1,11 @@ -CONFIG OPTIONS for erlang-client - - packageName - Erlang application name (convention: lowercase). (Default: openapi) - - packageName - Erlang application version (Default: 1.0.0) - -Back to the [generators list](README.md) +--- +id: generator-opts-client-erlang-client +title: Config Options for erlang-client +sidebar_label: erlang-client +--- + +| Option | Description | Values | Default | +| ------ | ----------- | ------ | ------- | +|packageName|Erlang application name (convention: lowercase).| |openapi| +|packageName|Erlang application version| |1.0.0| diff --git a/docs/generators/erlang-proper.md b/docs/generators/erlang-proper.md new file mode 100644 index 000000000000..1038343f8e8a --- /dev/null +++ b/docs/generators/erlang-proper.md @@ -0,0 +1,11 @@ + +--- +id: generator-opts-client-erlang-proper +title: Config Options for erlang-proper +sidebar_label: erlang-proper +--- + +| Option | Description | Values | Default | +| ------ | ----------- | ------ | ------- | +|packageName|Erlang application name (convention: lowercase).| |openapi| +|packageName|Erlang application version| |1.0.0| diff --git a/docs/generators/erlang-server.md b/docs/generators/erlang-server.md index 51fc0c2d9719..f469fc445e00 100644 --- a/docs/generators/erlang-server.md +++ b/docs/generators/erlang-server.md @@ -1,10 +1,11 @@ -CONFIG OPTIONS for erlang-server - - packageName - Erlang package name (convention: lowercase). (Default: openapi) - - openAPISpecName - Openapi Spec Name. (Default: openapi) - -Back to the [generators list](README.md) +--- +id: generator-opts-server-erlang-server +title: Config Options for erlang-server +sidebar_label: erlang-server +--- + +| Option | Description | Values | Default | +| ------ | ----------- | ------ | ------- | +|packageName|Erlang package name (convention: lowercase).| |openapi| +|openAPISpecName|Openapi Spec Name.| |openapi| diff --git a/docs/generators/flash.md b/docs/generators/flash.md index 4c84604c40a9..b91ea54475c0 100644 --- a/docs/generators/flash.md +++ b/docs/generators/flash.md @@ -1,16 +1,13 @@ -CONFIG OPTIONS for flash - - packageName - flash package name (convention: package.name) (Default: org.openapitools) - - packageVersion - flash package version (Default: 1.0.0) - - invokerPackage - root package for generated code - - sourceFolder - source folder for generated code. e.g. flash - -Back to the [generators list](README.md) +--- +id: generator-opts-client-flash +title: Config Options for flash +sidebar_label: flash +--- + +| Option | Description | Values | Default | +| ------ | ----------- | ------ | ------- | +|packageName|flash package name (convention: package.name)| |org.openapitools| +|packageVersion|flash package version| |1.0.0| +|invokerPackage|root package for generated code| |null| +|sourceFolder|source folder for generated code. e.g. flash| |null| diff --git a/docs/generators/go-gin-server.md b/docs/generators/go-gin-server.md index 1589b7f42a6f..9371bf027fde 100644 --- a/docs/generators/go-gin-server.md +++ b/docs/generators/go-gin-server.md @@ -1,10 +1,11 @@ -CONFIG OPTIONS for go-gin-server - - packageName - Go package name (convention: lowercase). (Default: openapi) - - hideGenerationTimestamp - Hides the generation timestamp when files are generated. (Default: true) - -Back to the [generators list](README.md) +--- +id: generator-opts-server-go-gin-server +title: Config Options for go-gin-server +sidebar_label: go-gin-server +--- + +| Option | Description | Values | Default | +| ------ | ----------- | ------ | ------- | +|packageName|Go package name (convention: lowercase).| |openapi| +|hideGenerationTimestamp|Hides the generation timestamp when files are generated.| |true| diff --git a/docs/generators/go-server.md b/docs/generators/go-server.md index 462aed9db17e..5ba67d6b3e60 100644 --- a/docs/generators/go-server.md +++ b/docs/generators/go-server.md @@ -1,10 +1,11 @@ -CONFIG OPTIONS for go-server - - packageName - Go package name (convention: lowercase). (Default: openapi) - - hideGenerationTimestamp - Hides the generation timestamp when files are generated. (Default: true) - -Back to the [generators list](README.md) +--- +id: generator-opts-server-go-server +title: Config Options for go-server +sidebar_label: go-server +--- + +| Option | Description | Values | Default | +| ------ | ----------- | ------ | ------- | +|packageName|Go package name (convention: lowercase).| |openapi| +|hideGenerationTimestamp|Hides the generation timestamp when files are generated.| |true| diff --git a/docs/generators/go.md b/docs/generators/go.md index f5b1c1ae9a99..d336f871529b 100644 --- a/docs/generators/go.md +++ b/docs/generators/go.md @@ -1,22 +1,15 @@ -CONFIG OPTIONS for go - - packageName - Go package name (convention: lowercase). (Default: openapi) - - hideGenerationTimestamp - Hides the generation timestamp when files are generated. (Default: true) - - packageVersion - Go package version. (Default: 1.0.0) - - withGoCodegenComment - whether to include Go codegen comment to disable Go Lint and collapse by default GitHub in PRs and diffs (Default: false) - - withXml - whether to include support for application/xml content type and include XML annotations in the model (works with libraries that provide support for JSON and XML) (Default: false) - - prependFormOrBodyParameters - Add form or body parameters to the beginning of the parameter list. (Default: false) - -Back to the [generators list](README.md) +--- +id: generator-opts-client-go +title: Config Options for go +sidebar_label: go +--- + +| Option | Description | Values | Default | +| ------ | ----------- | ------ | ------- | +|packageName|Go package name (convention: lowercase).| |openapi| +|hideGenerationTimestamp|Hides the generation timestamp when files are generated.| |true| +|packageVersion|Go package version.| |1.0.0| +|withGoCodegenComment|whether to include Go codegen comment to disable Go Lint and collapse by default GitHub in PRs and diffs| |false| +|withXml|whether to include support for application/xml content type and include XML annotations in the model (works with libraries that provide support for JSON and XML)| |false| +|prependFormOrBodyParameters|Add form or body parameters to the beginning of the parameter list.| |false| diff --git a/docs/generators/graphql-schema.md b/docs/generators/graphql-schema.md new file mode 100644 index 000000000000..a6d39fd6243a --- /dev/null +++ b/docs/generators/graphql-schema.md @@ -0,0 +1,12 @@ + +--- +id: generator-opts-config-graphql-schema +title: Config Options for graphql-schema +sidebar_label: graphql-schema +--- + +| Option | Description | Values | Default | +| ------ | ----------- | ------ | ------- | +|packageName|GraphQL package name (convention: lowercase).| |openapi2graphql| +|packageVersion|GraphQL package version.| |1.0.0| +|hideGenerationTimestamp|Hides the generation timestamp when files are generated.| |true| diff --git a/docs/generators/graphql-server.md b/docs/generators/graphql-server.md new file mode 100644 index 000000000000..97fb578008ab --- /dev/null +++ b/docs/generators/graphql-server.md @@ -0,0 +1,12 @@ + +--- +id: generator-opts-server-graphql-server +title: Config Options for graphql-server +sidebar_label: graphql-server +--- + +| Option | Description | Values | Default | +| ------ | ----------- | ------ | ------- | +|packageName|GraphQL express server package name (convention: lowercase).| |openapi3graphql-server| +|packageVersion|GraphQL express server package version.| |1.0.0| +|hideGenerationTimestamp|Hides the generation timestamp when files are generated.| |true| diff --git a/docs/generators/groovy.md b/docs/generators/groovy.md index 9a6ff34c6cf7..fa5e542697fb 100644 --- a/docs/generators/groovy.md +++ b/docs/generators/groovy.md @@ -1,119 +1,45 @@ -CONFIG OPTIONS for groovy - - sortParamsByRequiredFlag - Sort method arguments to place required parameters before optional parameters. (Default: true) - - ensureUniqueParams - Whether to ensure parameter names are unique in an operation (rename parameters that are not). (Default: true) - - allowUnicodeIdentifiers - boolean, toggles whether unicode identifiers are allowed in names or not, default is false (Default: false) - - prependFormOrBodyParameters - Add form or body parameters to the beginning of the parameter list. (Default: false) - - modelPackage - package for generated models - - apiPackage - package for generated api classes - - invokerPackage - root package for generated code - - groupId - groupId in generated pom.xml - - artifactId - artifactId in generated pom.xml - - artifactVersion - artifact version in generated pom.xml - - artifactUrl - artifact URL in generated pom.xml - - artifactDescription - artifact description in generated pom.xml - - scmConnection - SCM connection in generated pom.xml - - scmDeveloperConnection - SCM developer connection in generated pom.xml - - scmUrl - SCM URL in generated pom.xml - - developerName - developer name in generated pom.xml - - developerEmail - developer email in generated pom.xml - - developerOrganization - developer organization in generated pom.xml - - developerOrganizationUrl - developer organization URL in generated pom.xml - - licenseName - The name of the license - - licenseUrl - The URL of the license - - sourceFolder - source folder for generated code - - localVariablePrefix - prefix for generated code members and local variables - - serializableModel - boolean - toggle "implements Serializable" for generated models (Default: false) - - bigDecimalAsString - Treat BigDecimal values as Strings to avoid precision loss. (Default: false) - - fullJavaUtil - whether to use fully qualified name for classes under java.util. This option only works for Java API client (Default: false) - - hideGenerationTimestamp - hides the timestamp when files were generated - - withXml - whether to include support for application/xml content type and include XML annotations in the model (works with libraries that provide support for JSON and XML) (Default: false) - - dateLibrary - Option. Date library to use - joda - Joda (for legacy app only) - legacy - Legacy java.util.Date (if you really have a good reason not to use threetenbp - java8-localdatetime - Java 8 using LocalDateTime (for legacy app only) - java8 - Java 8 native JSR310 (preferred for jdk 1.8+) - note: this also sets "java8" to true - threetenbp - Backport of JSR310 (preferred for jdk < 1.8) - - java8 - Option. Use Java8 classes instead of third party equivalents - true - Use Java 8 classes such as Base64 - false - Various third party libraries as needed - - disableHtmlEscaping - Disable HTML escaping of JSON strings when using gson (needed to avoid problems with byte[] fields) (Default: false) - - booleanGetterPrefix - Set booleanGetterPrefix (default value 'get') - - parentGroupId - parent groupId in generated pom N.B. parentGroupId, parentArtifactId and parentVersion must all be specified for any of them to take effect - - parentArtifactId - parent artifactId in generated pom N.B. parentGroupId, parentArtifactId and parentVersion must all be specified for any of them to take effect - - parentVersion - parent version in generated pom N.B. parentGroupId, parentArtifactId and parentVersion must all be specified for any of them to take effect - - configPackage - configuration package for generated code - -Back to the [generators list](README.md) +--- +id: generator-opts-client-groovy +title: Config Options for groovy +sidebar_label: groovy +--- + +| Option | Description | Values | Default | +| ------ | ----------- | ------ | ------- | +|sortParamsByRequiredFlag|Sort method arguments 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| +|prependFormOrBodyParameters|Add form or body parameters to the beginning of the parameter list.| |false| +|modelPackage|package for generated models| |null| +|apiPackage|package for generated api classes| |null| +|invokerPackage|root package for generated code| |null| +|groupId|groupId in generated pom.xml| |null| +|artifactId|artifactId in generated pom.xml| |null| +|artifactVersion|artifact version in generated pom.xml| |null| +|artifactUrl|artifact URL in generated pom.xml| |null| +|artifactDescription|artifact description in generated pom.xml| |null| +|scmConnection|SCM connection in generated pom.xml| |null| +|scmDeveloperConnection|SCM developer connection in generated pom.xml| |null| +|scmUrl|SCM URL in generated pom.xml| |null| +|developerName|developer name in generated pom.xml| |null| +|developerEmail|developer email in generated pom.xml| |null| +|developerOrganization|developer organization in generated pom.xml| |null| +|developerOrganizationUrl|developer organization URL in generated pom.xml| |null| +|licenseName|The name of the license| |null| +|licenseUrl|The URL of the license| |null| +|sourceFolder|source folder for generated code| |null| +|localVariablePrefix|prefix for generated code members and local variables| |null| +|serializableModel|boolean - toggle "implements Serializable" for generated models| |false| +|bigDecimalAsString|Treat BigDecimal values as Strings to avoid precision loss.| |false| +|fullJavaUtil|whether to use fully qualified name for classes under java.util. This option only works for Java API client| |false| +|hideGenerationTimestamp|hides the timestamp when files were generated| |null| +|withXml|whether to include support for application/xml content type and include XML annotations in the model (works with libraries that provide support for JSON and XML)| |false| +|dateLibrary|Option. Date library to use|
**joda**
Joda (for legacy app only)
**legacy**
Legacy java.util.Date (if you really have a good reason not to use threetenbp
**java8-localdatetime**
Java 8 using LocalDateTime (for legacy app only)
**java8**
Java 8 native JSR310 (preferred for jdk 1.8+) - note: this also sets "java8" to true
**threetenbp**
Backport of JSR310 (preferred for jdk < 1.8)
|null| +|java8|Option. Use Java8 classes instead of third party equivalents|
**true**
Use Java 8 classes such as Base64
**false**
Various third party libraries as needed
|null| +|disableHtmlEscaping|Disable HTML escaping of JSON strings when using gson (needed to avoid problems with byte[] fields)| |false| +|booleanGetterPrefix|Set booleanGetterPrefix (default value 'get')| |null| +|parentGroupId|parent groupId in generated pom N.B. parentGroupId, parentArtifactId and parentVersion must all be specified for any of them to take effect| |null| +|parentArtifactId|parent artifactId in generated pom N.B. parentGroupId, parentArtifactId and parentVersion must all be specified for any of them to take effect| |null| +|parentVersion|parent version in generated pom N.B. parentGroupId, parentArtifactId and parentVersion must all be specified for any of them to take effect| |null| +|configPackage|configuration package for generated code| |null| diff --git a/docs/generators/haskell-http-client.md b/docs/generators/haskell-http-client.md index af303d7cd44f..a39a6707addc 100644 --- a/docs/generators/haskell-http-client.md +++ b/docs/generators/haskell-http-client.md @@ -1,73 +1,32 @@ -CONFIG OPTIONS for haskell-http-client - - sortParamsByRequiredFlag - Sort method arguments to place required parameters before optional parameters. (Default: true) - - ensureUniqueParams - Whether to ensure parameter names are unique in an operation (rename parameters that are not). (Default: true) - - allowUnicodeIdentifiers - boolean, toggles whether unicode identifiers are allowed in names or not, default is false (Default: false) - - prependFormOrBodyParameters - Add form or body parameters to the beginning of the parameter list. (Default: false) - - cabalPackage - Set the cabal package name, which consists of one or more alphanumeric words separated by hyphens - - cabalVersion - Set the cabal version number, consisting of a sequence of one or more integers separated by dots - - baseModule - Set the base module namespace - - requestType - Set the name of the type used to generate requests - - configType - Set the name of the type used for configuration - - allowFromJsonNulls - allow JSON Null during model decoding from JSON (Default: true) - - allowToJsonNulls - allow emitting JSON Null during model encoding to JSON (Default: false) - - allowNonUniqueOperationIds - allow different API modules to contain the same operationId. Each API must be imported qualified (Default: false) - - generateLenses - Generate Lens optics for Models (Default: true) - - generateModelConstructors - Generate smart constructors (only supply required fields) for models (Default: true) - - generateEnums - Generate specific datatypes for OpenAPI enums (Default: true) - - generateFormUrlEncodedInstances - Generate FromForm/ToForm instances for models that are used by operations that produce or consume application/x-www-form-urlencoded (Default: true) - - inlineMimeTypes - Inline (hardcode) the content-type and accept parameters on operations, when there is only 1 option (Default: true) - - modelDeriving - Additional classes to include in the deriving() clause of Models - - strictFields - Add strictness annotations to all model fields (Default: true) - - useMonadLogger - Use the monad-logger package to provide logging (if false, use the katip logging package) (Default: false) - - dateTimeFormat - format string used to parse/render a datetime - - dateFormat - format string used to parse/render a date (Default: %Y-%m-%d) - - hideGenerationTimestamp - Hides the generation timestamp when files are generated. (Default: true) - -Back to the [generators list](README.md) +--- +id: generator-opts-client-haskell-http-client +title: Config Options for haskell-http-client +sidebar_label: haskell-http-client +--- + +| Option | Description | Values | Default | +| ------ | ----------- | ------ | ------- | +|sortParamsByRequiredFlag|Sort method arguments 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| +|prependFormOrBodyParameters|Add form or body parameters to the beginning of the parameter list.| |false| +|cabalPackage|Set the cabal package name, which consists of one or more alphanumeric words separated by hyphens| |null| +|cabalVersion|Set the cabal version number, consisting of a sequence of one or more integers separated by dots| |null| +|baseModule|Set the base module namespace| |null| +|requestType|Set the name of the type used to generate requests| |null| +|configType|Set the name of the type used for configuration| |null| +|allowFromJsonNulls|allow JSON Null during model decoding from JSON| |true| +|allowToJsonNulls|allow emitting JSON Null during model encoding to JSON| |false| +|allowNonUniqueOperationIds|allow different API modules to contain the same operationId. Each API must be imported qualified| |false| +|generateLenses|Generate Lens optics for Models| |true| +|generateModelConstructors|Generate smart constructors (only supply required fields) for models| |true| +|generateEnums|Generate specific datatypes for OpenAPI enums| |true| +|generateFormUrlEncodedInstances|Generate FromForm/ToForm instances for models that are used by operations that produce or consume application/x-www-form-urlencoded| |true| +|inlineMimeTypes|Inline (hardcode) the content-type and accept parameters on operations, when there is only 1 option| |true| +|modelDeriving|Additional classes to include in the deriving() clause of Models| |null| +|strictFields|Add strictness annotations to all model fields| |true| +|useMonadLogger|Use the monad-logger package to provide logging (if false, use the katip logging package)| |false| +|dateTimeFormat|format string used to parse/render a datetime| |null| +|dateFormat|format string used to parse/render a date| |%Y-%m-%d| +|hideGenerationTimestamp|Hides the generation timestamp when files are generated.| |true| diff --git a/docs/generators/haskell.md b/docs/generators/haskell.md index 3fbbb3f5aee4..3692c19bb3fb 100644 --- a/docs/generators/haskell.md +++ b/docs/generators/haskell.md @@ -1,22 +1,15 @@ -CONFIG OPTIONS for haskell - - sortParamsByRequiredFlag - Sort method arguments to place required parameters before optional parameters. (Default: true) - - ensureUniqueParams - Whether to ensure parameter names are unique in an operation (rename parameters that are not). (Default: true) - - allowUnicodeIdentifiers - boolean, toggles whether unicode identifiers are allowed in names or not, default is false (Default: false) - - prependFormOrBodyParameters - Add form or body parameters to the beginning of the parameter list. (Default: false) - - modelPackage - package for generated models - - apiPackage - package for generated api classes - -Back to the [generators list](README.md) +--- +id: generator-opts-server-haskell +title: Config Options for haskell +sidebar_label: haskell +--- + +| Option | Description | Values | Default | +| ------ | ----------- | ------ | ------- | +|sortParamsByRequiredFlag|Sort method arguments 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| +|prependFormOrBodyParameters|Add form or body parameters to the beginning of the parameter list.| |false| +|modelPackage|package for generated models| |null| +|apiPackage|package for generated api classes| |null| diff --git a/docs/generators/html.md b/docs/generators/html.md index 61384bb6c209..53e8dd7d65a2 100644 --- a/docs/generators/html.md +++ b/docs/generators/html.md @@ -1,46 +1,23 @@ -CONFIG OPTIONS for html - - sortParamsByRequiredFlag - Sort method arguments to place required parameters before optional parameters. (Default: true) - - ensureUniqueParams - Whether to ensure parameter names are unique in an operation (rename parameters that are not). (Default: true) - - allowUnicodeIdentifiers - boolean, toggles whether unicode identifiers are allowed in names or not, default is false (Default: false) - - prependFormOrBodyParameters - Add form or body parameters to the beginning of the parameter list. (Default: false) - - appName - short name of the application - - appDescription - description of the application - - infoUrl - a URL where users can get more information about the application - - infoEmail - an email address to contact for inquiries about the application - - licenseInfo - a short description of the license - - licenseUrl - a URL pointing to the full license - - invokerPackage - root package for generated code - - groupId - groupId in generated pom.xml - - artifactId - artifactId in generated pom.xml - - artifactVersion - artifact version in generated pom.xml - -Back to the [generators list](README.md) +--- +id: generator-opts-documentation-html +title: Config Options for html +sidebar_label: html +--- + +| Option | Description | Values | Default | +| ------ | ----------- | ------ | ------- | +|sortParamsByRequiredFlag|Sort method arguments 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| +|prependFormOrBodyParameters|Add form or body parameters to the beginning of the parameter list.| |false| +|appName|short name of the application| |null| +|appDescription|description of the application| |null| +|infoUrl|a URL where users can get more information about the application| |null| +|infoEmail|an email address to contact for inquiries about the application| |null| +|licenseInfo|a short description of the license| |null| +|licenseUrl|a URL pointing to the full license| |null| +|invokerPackage|root package for generated code| |null| +|groupId|groupId in generated pom.xml| |null| +|artifactId|artifactId in generated pom.xml| |null| +|artifactVersion|artifact version in generated pom.xml| |null| diff --git a/docs/generators/html2.md b/docs/generators/html2.md index 3e17d6931222..ac52e90608b3 100644 --- a/docs/generators/html2.md +++ b/docs/generators/html2.md @@ -1,58 +1,27 @@ -CONFIG OPTIONS for html2 - - sortParamsByRequiredFlag - Sort method arguments to place required parameters before optional parameters. (Default: true) - - ensureUniqueParams - Whether to ensure parameter names are unique in an operation (rename parameters that are not). (Default: true) - - allowUnicodeIdentifiers - boolean, toggles whether unicode identifiers are allowed in names or not, default is false (Default: false) - - prependFormOrBodyParameters - Add form or body parameters to the beginning of the parameter list. (Default: false) - - appName - short name of the application - - appDescription - description of the application - - infoUrl - a URL where users can get more information about the application - - infoEmail - an email address to contact for inquiries about the application - - licenseInfo - a short description of the license - - licenseUrl - a URL pointing to the full license - - invokerPackage - root package for generated code - - phpInvokerPackage - root package for generated php code - - perlModuleName - root module name for generated perl code - - pythonPackageName - package name for generated python code - - packageName - C# package name - - groupId - groupId in generated pom.xml - - artifactId - artifactId in generated pom.xml - - artifactVersion - artifact version in generated pom.xml - -Back to the [generators list](README.md) +--- +id: generator-opts-documentation-html2 +title: Config Options for html2 +sidebar_label: html2 +--- + +| Option | Description | Values | Default | +| ------ | ----------- | ------ | ------- | +|sortParamsByRequiredFlag|Sort method arguments 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| +|prependFormOrBodyParameters|Add form or body parameters to the beginning of the parameter list.| |false| +|appName|short name of the application| |null| +|appDescription|description of the application| |null| +|infoUrl|a URL where users can get more information about the application| |null| +|infoEmail|an email address to contact for inquiries about the application| |null| +|licenseInfo|a short description of the license| |null| +|licenseUrl|a URL pointing to the full license| |null| +|invokerPackage|root package for generated code| |null| +|phpInvokerPackage|root package for generated php code| |null| +|perlModuleName|root module name for generated perl code| |null| +|pythonPackageName|package name for generated python code| |null| +|packageName|C# package name| |null| +|groupId|groupId in generated pom.xml| |null| +|artifactId|artifactId in generated pom.xml| |null| +|artifactVersion|artifact version in generated pom.xml| |null| diff --git a/docs/generators/java-inflector.md b/docs/generators/java-inflector.md index f142ee247bd9..e2b2fc439f29 100644 --- a/docs/generators/java-inflector.md +++ b/docs/generators/java-inflector.md @@ -1,116 +1,44 @@ -CONFIG OPTIONS for java-inflector - - sortParamsByRequiredFlag - Sort method arguments to place required parameters before optional parameters. (Default: true) - - ensureUniqueParams - Whether to ensure parameter names are unique in an operation (rename parameters that are not). (Default: true) - - allowUnicodeIdentifiers - boolean, toggles whether unicode identifiers are allowed in names or not, default is false (Default: false) - - prependFormOrBodyParameters - Add form or body parameters to the beginning of the parameter list. (Default: false) - - modelPackage - package for generated models - - apiPackage - package for generated api classes - - invokerPackage - root package for generated code - - groupId - groupId in generated pom.xml - - artifactId - artifactId in generated pom.xml - - artifactVersion - artifact version in generated pom.xml - - artifactUrl - artifact URL in generated pom.xml - - artifactDescription - artifact description in generated pom.xml - - scmConnection - SCM connection in generated pom.xml - - scmDeveloperConnection - SCM developer connection in generated pom.xml - - scmUrl - SCM URL in generated pom.xml - - developerName - developer name in generated pom.xml - - developerEmail - developer email in generated pom.xml - - developerOrganization - developer organization in generated pom.xml - - developerOrganizationUrl - developer organization URL in generated pom.xml - - licenseName - The name of the license - - licenseUrl - The URL of the license - - sourceFolder - source folder for generated code - - localVariablePrefix - prefix for generated code members and local variables - - serializableModel - boolean - toggle "implements Serializable" for generated models (Default: false) - - bigDecimalAsString - Treat BigDecimal values as Strings to avoid precision loss. (Default: false) - - fullJavaUtil - whether to use fully qualified name for classes under java.util. This option only works for Java API client (Default: false) - - hideGenerationTimestamp - hides the timestamp when files were generated - - withXml - whether to include support for application/xml content type and include XML annotations in the model (works with libraries that provide support for JSON and XML) (Default: false) - - dateLibrary - Option. Date library to use - joda - Joda (for legacy app only) - legacy - Legacy java.util.Date (if you really have a good reason not to use threetenbp - java8-localdatetime - Java 8 using LocalDateTime (for legacy app only) - java8 - Java 8 native JSR310 (preferred for jdk 1.8+) - note: this also sets "java8" to true - threetenbp - Backport of JSR310 (preferred for jdk < 1.8) - - java8 - Option. Use Java8 classes instead of third party equivalents - true - Use Java 8 classes such as Base64 - false - Various third party libraries as needed - - disableHtmlEscaping - Disable HTML escaping of JSON strings when using gson (needed to avoid problems with byte[] fields) (Default: false) - - booleanGetterPrefix - Set booleanGetterPrefix (default value 'get') - - parentGroupId - parent groupId in generated pom N.B. parentGroupId, parentArtifactId and parentVersion must all be specified for any of them to take effect - - parentArtifactId - parent artifactId in generated pom N.B. parentGroupId, parentArtifactId and parentVersion must all be specified for any of them to take effect - - parentVersion - parent version in generated pom N.B. parentGroupId, parentArtifactId and parentVersion must all be specified for any of them to take effect - -Back to the [generators list](README.md) +--- +id: generator-opts-server-java-inflector +title: Config Options for java-inflector +sidebar_label: java-inflector +--- + +| Option | Description | Values | Default | +| ------ | ----------- | ------ | ------- | +|sortParamsByRequiredFlag|Sort method arguments 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| +|prependFormOrBodyParameters|Add form or body parameters to the beginning of the parameter list.| |false| +|modelPackage|package for generated models| |null| +|apiPackage|package for generated api classes| |null| +|invokerPackage|root package for generated code| |null| +|groupId|groupId in generated pom.xml| |null| +|artifactId|artifactId in generated pom.xml| |null| +|artifactVersion|artifact version in generated pom.xml| |null| +|artifactUrl|artifact URL in generated pom.xml| |null| +|artifactDescription|artifact description in generated pom.xml| |null| +|scmConnection|SCM connection in generated pom.xml| |null| +|scmDeveloperConnection|SCM developer connection in generated pom.xml| |null| +|scmUrl|SCM URL in generated pom.xml| |null| +|developerName|developer name in generated pom.xml| |null| +|developerEmail|developer email in generated pom.xml| |null| +|developerOrganization|developer organization in generated pom.xml| |null| +|developerOrganizationUrl|developer organization URL in generated pom.xml| |null| +|licenseName|The name of the license| |null| +|licenseUrl|The URL of the license| |null| +|sourceFolder|source folder for generated code| |null| +|localVariablePrefix|prefix for generated code members and local variables| |null| +|serializableModel|boolean - toggle "implements Serializable" for generated models| |false| +|bigDecimalAsString|Treat BigDecimal values as Strings to avoid precision loss.| |false| +|fullJavaUtil|whether to use fully qualified name for classes under java.util. This option only works for Java API client| |false| +|hideGenerationTimestamp|hides the timestamp when files were generated| |null| +|withXml|whether to include support for application/xml content type and include XML annotations in the model (works with libraries that provide support for JSON and XML)| |false| +|dateLibrary|Option. Date library to use|
**joda**
Joda (for legacy app only)
**legacy**
Legacy java.util.Date (if you really have a good reason not to use threetenbp
**java8-localdatetime**
Java 8 using LocalDateTime (for legacy app only)
**java8**
Java 8 native JSR310 (preferred for jdk 1.8+) - note: this also sets "java8" to true
**threetenbp**
Backport of JSR310 (preferred for jdk < 1.8)
|null| +|java8|Option. Use Java8 classes instead of third party equivalents|
**true**
Use Java 8 classes such as Base64
**false**
Various third party libraries as needed
|null| +|disableHtmlEscaping|Disable HTML escaping of JSON strings when using gson (needed to avoid problems with byte[] fields)| |false| +|booleanGetterPrefix|Set booleanGetterPrefix (default value 'get')| |null| +|parentGroupId|parent groupId in generated pom N.B. parentGroupId, parentArtifactId and parentVersion must all be specified for any of them to take effect| |null| +|parentArtifactId|parent artifactId in generated pom N.B. parentGroupId, parentArtifactId and parentVersion must all be specified for any of them to take effect| |null| +|parentVersion|parent version in generated pom N.B. parentGroupId, parentArtifactId and parentVersion must all be specified for any of them to take effect| |null| diff --git a/docs/generators/java-msf4j.md b/docs/generators/java-msf4j.md index b2817e0b7c19..899e7c7e7e7a 100644 --- a/docs/generators/java-msf4j.md +++ b/docs/generators/java-msf4j.md @@ -1,133 +1,49 @@ -CONFIG OPTIONS for java-msf4j - - sortParamsByRequiredFlag - Sort method arguments to place required parameters before optional parameters. (Default: true) - - ensureUniqueParams - Whether to ensure parameter names are unique in an operation (rename parameters that are not). (Default: true) - - allowUnicodeIdentifiers - boolean, toggles whether unicode identifiers are allowed in names or not, default is false (Default: false) - - prependFormOrBodyParameters - Add form or body parameters to the beginning of the parameter list. (Default: false) - - modelPackage - package for generated models - - apiPackage - package for generated api classes - - invokerPackage - root package for generated code - - groupId - groupId in generated pom.xml - - artifactId - artifactId in generated pom.xml - - artifactVersion - artifact version in generated pom.xml - - artifactUrl - artifact URL in generated pom.xml - - artifactDescription - artifact description in generated pom.xml - - scmConnection - SCM connection in generated pom.xml - - scmDeveloperConnection - SCM developer connection in generated pom.xml - - scmUrl - SCM URL in generated pom.xml - - developerName - developer name in generated pom.xml - - developerEmail - developer email in generated pom.xml - - developerOrganization - developer organization in generated pom.xml - - developerOrganizationUrl - developer organization URL in generated pom.xml - - licenseName - The name of the license - - licenseUrl - The URL of the license - - sourceFolder - source folder for generated code - - localVariablePrefix - prefix for generated code members and local variables - - serializableModel - boolean - toggle "implements Serializable" for generated models (Default: false) - - bigDecimalAsString - Treat BigDecimal values as Strings to avoid precision loss. (Default: false) - - fullJavaUtil - whether to use fully qualified name for classes under java.util. This option only works for Java API client (Default: false) - - hideGenerationTimestamp - hides the timestamp when files were generated - - withXml - whether to include support for application/xml content type and include XML annotations in the model (works with libraries that provide support for JSON and XML) (Default: false) - - dateLibrary - Option. Date library to use - joda - Joda (for legacy app only) - legacy - Legacy java.util.Date (if you really have a good reason not to use threetenbp - java8-localdatetime - Java 8 using LocalDateTime (for legacy app only) - java8 - Java 8 native JSR310 (preferred for jdk 1.8+) - note: this also sets "java8" to true - threetenbp - Backport of JSR310 (preferred for jdk < 1.8) - - java8 - Option. Use Java8 classes instead of third party equivalents - true - Use Java 8 classes such as Base64 - false - Various third party libraries as needed - - disableHtmlEscaping - Disable HTML escaping of JSON strings when using gson (needed to avoid problems with byte[] fields) (Default: false) - - booleanGetterPrefix - Set booleanGetterPrefix (default value 'get') - - parentGroupId - parent groupId in generated pom N.B. parentGroupId, parentArtifactId and parentVersion must all be specified for any of them to take effect - - parentArtifactId - parent artifactId in generated pom N.B. parentGroupId, parentArtifactId and parentVersion must all be specified for any of them to take effect - - parentVersion - parent version in generated pom N.B. parentGroupId, parentArtifactId and parentVersion must all be specified for any of them to take effect - - implFolder - folder for generated implementation code - - title - a title describing the application - - useBeanValidation - Use BeanValidation API annotations (Default: true) - - serverPort - The port on which the server should be started - - library - library template (sub-template) to use (Default: jersey2) - jersey1 - Jersey core 1.x - jersey2 - Jersey core 2.x - -Back to the [generators list](README.md) +--- +id: generator-opts-server-java-msf4j +title: Config Options for java-msf4j +sidebar_label: java-msf4j +--- + +| Option | Description | Values | Default | +| ------ | ----------- | ------ | ------- | +|sortParamsByRequiredFlag|Sort method arguments 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| +|prependFormOrBodyParameters|Add form or body parameters to the beginning of the parameter list.| |false| +|modelPackage|package for generated models| |null| +|apiPackage|package for generated api classes| |null| +|invokerPackage|root package for generated code| |null| +|groupId|groupId in generated pom.xml| |null| +|artifactId|artifactId in generated pom.xml| |null| +|artifactVersion|artifact version in generated pom.xml| |null| +|artifactUrl|artifact URL in generated pom.xml| |null| +|artifactDescription|artifact description in generated pom.xml| |null| +|scmConnection|SCM connection in generated pom.xml| |null| +|scmDeveloperConnection|SCM developer connection in generated pom.xml| |null| +|scmUrl|SCM URL in generated pom.xml| |null| +|developerName|developer name in generated pom.xml| |null| +|developerEmail|developer email in generated pom.xml| |null| +|developerOrganization|developer organization in generated pom.xml| |null| +|developerOrganizationUrl|developer organization URL in generated pom.xml| |null| +|licenseName|The name of the license| |null| +|licenseUrl|The URL of the license| |null| +|sourceFolder|source folder for generated code| |null| +|localVariablePrefix|prefix for generated code members and local variables| |null| +|serializableModel|boolean - toggle "implements Serializable" for generated models| |false| +|bigDecimalAsString|Treat BigDecimal values as Strings to avoid precision loss.| |false| +|fullJavaUtil|whether to use fully qualified name for classes under java.util. This option only works for Java API client| |false| +|hideGenerationTimestamp|hides the timestamp when files were generated| |null| +|withXml|whether to include support for application/xml content type and include XML annotations in the model (works with libraries that provide support for JSON and XML)| |false| +|dateLibrary|Option. Date library to use|
**joda**
Joda (for legacy app only)
**legacy**
Legacy java.util.Date (if you really have a good reason not to use threetenbp
**java8-localdatetime**
Java 8 using LocalDateTime (for legacy app only)
**java8**
Java 8 native JSR310 (preferred for jdk 1.8+) - note: this also sets "java8" to true
**threetenbp**
Backport of JSR310 (preferred for jdk < 1.8)
|null| +|java8|Option. Use Java8 classes instead of third party equivalents|
**true**
Use Java 8 classes such as Base64
**false**
Various third party libraries as needed
|null| +|disableHtmlEscaping|Disable HTML escaping of JSON strings when using gson (needed to avoid problems with byte[] fields)| |false| +|booleanGetterPrefix|Set booleanGetterPrefix (default value 'get')| |null| +|parentGroupId|parent groupId in generated pom N.B. parentGroupId, parentArtifactId and parentVersion must all be specified for any of them to take effect| |null| +|parentArtifactId|parent artifactId in generated pom N.B. parentGroupId, parentArtifactId and parentVersion must all be specified for any of them to take effect| |null| +|parentVersion|parent version in generated pom N.B. parentGroupId, parentArtifactId and parentVersion must all be specified for any of them to take effect| |null| +|implFolder|folder for generated implementation code| |null| +|title|a title describing the application| |null| +|useBeanValidation|Use BeanValidation API annotations| |true| +|serverPort|The port on which the server should be started| |null| +|library|library template (sub-template) to use|
**jersey1**
Jersey core 1.x
**jersey2**
Jersey core 2.x
|jersey2| diff --git a/docs/generators/java-pkmst.md b/docs/generators/java-pkmst.md index 1cab3be93baf..baefba28819c 100644 --- a/docs/generators/java-pkmst.md +++ b/docs/generators/java-pkmst.md @@ -1,146 +1,54 @@ -CONFIG OPTIONS for java-pkmst - - sortParamsByRequiredFlag - Sort method arguments to place required parameters before optional parameters. (Default: true) - - ensureUniqueParams - Whether to ensure parameter names are unique in an operation (rename parameters that are not). (Default: true) - - allowUnicodeIdentifiers - boolean, toggles whether unicode identifiers are allowed in names or not, default is false (Default: false) - - prependFormOrBodyParameters - Add form or body parameters to the beginning of the parameter list. (Default: false) - - modelPackage - package for generated models - - apiPackage - package for generated api classes - - invokerPackage - root package for generated code - - groupId - groupId in generated pom.xml - - artifactId - artifactId in generated pom.xml - - artifactVersion - artifact version in generated pom.xml - - artifactUrl - artifact URL in generated pom.xml - - artifactDescription - artifact description in generated pom.xml - - scmConnection - SCM connection in generated pom.xml - - scmDeveloperConnection - SCM developer connection in generated pom.xml - - scmUrl - SCM URL in generated pom.xml - - developerName - developer name in generated pom.xml - - developerEmail - developer email in generated pom.xml - - developerOrganization - developer organization in generated pom.xml - - developerOrganizationUrl - developer organization URL in generated pom.xml - - licenseName - The name of the license - - licenseUrl - The URL of the license - - sourceFolder - source folder for generated code - - localVariablePrefix - prefix for generated code members and local variables - - serializableModel - boolean - toggle "implements Serializable" for generated models (Default: false) - - bigDecimalAsString - Treat BigDecimal values as Strings to avoid precision loss. (Default: false) - - fullJavaUtil - whether to use fully qualified name for classes under java.util. This option only works for Java API client (Default: false) - - hideGenerationTimestamp - hides the timestamp when files were generated - - withXml - whether to include support for application/xml content type and include XML annotations in the model (works with libraries that provide support for JSON and XML) (Default: false) - - dateLibrary - Option. Date library to use - joda - Joda (for legacy app only) - legacy - Legacy java.util.Date (if you really have a good reason not to use threetenbp - java8-localdatetime - Java 8 using LocalDateTime (for legacy app only) - java8 - Java 8 native JSR310 (preferred for jdk 1.8+) - note: this also sets "java8" to true - threetenbp - Backport of JSR310 (preferred for jdk < 1.8) - - java8 - Option. Use Java8 classes instead of third party equivalents - true - Use Java 8 classes such as Base64 - false - Various third party libraries as needed - - disableHtmlEscaping - Disable HTML escaping of JSON strings when using gson (needed to avoid problems with byte[] fields) (Default: false) - - booleanGetterPrefix - Set booleanGetterPrefix (default value 'get') - - parentGroupId - parent groupId in generated pom N.B. parentGroupId, parentArtifactId and parentVersion must all be specified for any of them to take effect - - parentArtifactId - parent artifactId in generated pom N.B. parentGroupId, parentArtifactId and parentVersion must all be specified for any of them to take effect - - parentVersion - parent version in generated pom N.B. parentGroupId, parentArtifactId and parentVersion must all be specified for any of them to take effect - - groupId - groupId in generated pom.xml - - artifactId - artifactId in generated pom.xml - - artifactVersion - artifact version in generated pom.xml - - basePackage - base package for java source code - - serviceName - Service Name - - title - server title name or client service name - - eurekaUri - Eureka URI - - zipkinUri - Zipkin URI - - springBootAdminUri - Spring-Boot URI - - pkmstInterceptor - PKMST Interceptor - -Back to the [generators list](README.md) +--- +id: generator-opts-server-java-pkmst +title: Config Options for java-pkmst +sidebar_label: java-pkmst +--- + +| Option | Description | Values | Default | +| ------ | ----------- | ------ | ------- | +|sortParamsByRequiredFlag|Sort method arguments 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| +|prependFormOrBodyParameters|Add form or body parameters to the beginning of the parameter list.| |false| +|modelPackage|package for generated models| |null| +|apiPackage|package for generated api classes| |null| +|invokerPackage|root package for generated code| |null| +|groupId|groupId in generated pom.xml| |null| +|artifactId|artifactId in generated pom.xml| |null| +|artifactVersion|artifact version in generated pom.xml| |null| +|artifactUrl|artifact URL in generated pom.xml| |null| +|artifactDescription|artifact description in generated pom.xml| |null| +|scmConnection|SCM connection in generated pom.xml| |null| +|scmDeveloperConnection|SCM developer connection in generated pom.xml| |null| +|scmUrl|SCM URL in generated pom.xml| |null| +|developerName|developer name in generated pom.xml| |null| +|developerEmail|developer email in generated pom.xml| |null| +|developerOrganization|developer organization in generated pom.xml| |null| +|developerOrganizationUrl|developer organization URL in generated pom.xml| |null| +|licenseName|The name of the license| |null| +|licenseUrl|The URL of the license| |null| +|sourceFolder|source folder for generated code| |null| +|localVariablePrefix|prefix for generated code members and local variables| |null| +|serializableModel|boolean - toggle "implements Serializable" for generated models| |false| +|bigDecimalAsString|Treat BigDecimal values as Strings to avoid precision loss.| |false| +|fullJavaUtil|whether to use fully qualified name for classes under java.util. This option only works for Java API client| |false| +|hideGenerationTimestamp|hides the timestamp when files were generated| |null| +|withXml|whether to include support for application/xml content type and include XML annotations in the model (works with libraries that provide support for JSON and XML)| |false| +|dateLibrary|Option. Date library to use|
**joda**
Joda (for legacy app only)
**legacy**
Legacy java.util.Date (if you really have a good reason not to use threetenbp
**java8-localdatetime**
Java 8 using LocalDateTime (for legacy app only)
**java8**
Java 8 native JSR310 (preferred for jdk 1.8+) - note: this also sets "java8" to true
**threetenbp**
Backport of JSR310 (preferred for jdk < 1.8)
|null| +|java8|Option. Use Java8 classes instead of third party equivalents|
**true**
Use Java 8 classes such as Base64
**false**
Various third party libraries as needed
|null| +|disableHtmlEscaping|Disable HTML escaping of JSON strings when using gson (needed to avoid problems with byte[] fields)| |false| +|booleanGetterPrefix|Set booleanGetterPrefix (default value 'get')| |null| +|parentGroupId|parent groupId in generated pom N.B. parentGroupId, parentArtifactId and parentVersion must all be specified for any of them to take effect| |null| +|parentArtifactId|parent artifactId in generated pom N.B. parentGroupId, parentArtifactId and parentVersion must all be specified for any of them to take effect| |null| +|parentVersion|parent version in generated pom N.B. parentGroupId, parentArtifactId and parentVersion must all be specified for any of them to take effect| |null| +|groupId|groupId in generated pom.xml| |null| +|artifactId|artifactId in generated pom.xml| |null| +|artifactVersion|artifact version in generated pom.xml| |null| +|basePackage|base package for java source code| |null| +|serviceName|Service Name| |null| +|title|server title name or client service name| |null| +|eurekaUri|Eureka URI| |null| +|zipkinUri|Zipkin URI| |null| +|springBootAdminUri|Spring-Boot URI| |null| +|pkmstInterceptor|PKMST Interceptor| |null| diff --git a/docs/generators/java-play-framework.md b/docs/generators/java-play-framework.md index 801c965df75c..444c85a52a35 100644 --- a/docs/generators/java-play-framework.md +++ b/docs/generators/java-play-framework.md @@ -1,143 +1,53 @@ -CONFIG OPTIONS for java-play-framework - - sortParamsByRequiredFlag - Sort method arguments to place required parameters before optional parameters. (Default: true) - - ensureUniqueParams - Whether to ensure parameter names are unique in an operation (rename parameters that are not). (Default: true) - - allowUnicodeIdentifiers - boolean, toggles whether unicode identifiers are allowed in names or not, default is false (Default: false) - - prependFormOrBodyParameters - Add form or body parameters to the beginning of the parameter list. (Default: false) - - modelPackage - package for generated models - - apiPackage - package for generated api classes - - invokerPackage - root package for generated code - - groupId - groupId in generated pom.xml - - artifactId - artifactId in generated pom.xml - - artifactVersion - artifact version in generated pom.xml - - artifactUrl - artifact URL in generated pom.xml - - artifactDescription - artifact description in generated pom.xml - - scmConnection - SCM connection in generated pom.xml - - scmDeveloperConnection - SCM developer connection in generated pom.xml - - scmUrl - SCM URL in generated pom.xml - - developerName - developer name in generated pom.xml - - developerEmail - developer email in generated pom.xml - - developerOrganization - developer organization in generated pom.xml - - developerOrganizationUrl - developer organization URL in generated pom.xml - - licenseName - The name of the license - - licenseUrl - The URL of the license - - sourceFolder - source folder for generated code - - localVariablePrefix - prefix for generated code members and local variables - - serializableModel - boolean - toggle "implements Serializable" for generated models (Default: false) - - bigDecimalAsString - Treat BigDecimal values as Strings to avoid precision loss. (Default: false) - - fullJavaUtil - whether to use fully qualified name for classes under java.util. This option only works for Java API client (Default: false) - - hideGenerationTimestamp - hides the timestamp when files were generated - - withXml - whether to include support for application/xml content type and include XML annotations in the model (works with libraries that provide support for JSON and XML) (Default: false) - - dateLibrary - Option. Date library to use - joda - Joda (for legacy app only) - legacy - Legacy java.util.Date (if you really have a good reason not to use threetenbp - java8-localdatetime - Java 8 using LocalDateTime (for legacy app only) - java8 - Java 8 native JSR310 (preferred for jdk 1.8+) - note: this also sets "java8" to true - threetenbp - Backport of JSR310 (preferred for jdk < 1.8) - - java8 - Option. Use Java8 classes instead of third party equivalents - true - Use Java 8 classes such as Base64 - false - Various third party libraries as needed - - disableHtmlEscaping - Disable HTML escaping of JSON strings when using gson (needed to avoid problems with byte[] fields) (Default: false) - - booleanGetterPrefix - Set booleanGetterPrefix (default value 'get') - - parentGroupId - parent groupId in generated pom N.B. parentGroupId, parentArtifactId and parentVersion must all be specified for any of them to take effect - - parentArtifactId - parent artifactId in generated pom N.B. parentGroupId, parentArtifactId and parentVersion must all be specified for any of them to take effect - - parentVersion - parent version in generated pom N.B. parentGroupId, parentArtifactId and parentVersion must all be specified for any of them to take effect - - title - server title name or client service name - - configPackage - configuration package for generated code - - basePackage - base package for generated code - - controllerOnly - Whether to generate only API interface stubs without the server files. (Default: false) - - useBeanValidation - Use BeanValidation API annotations (Default: true) - - useInterfaces - Makes the controllerImp implements an interface to facilitate automatic completion when updating from version x to y of your spec (Default: true) - - handleExceptions - Add a 'throw exception' to each controller function. Add also a custom error handler where you can put your custom logic (Default: true) - - wrapCalls - Add a wrapper to each controller function to handle things like metrics, response modification, etc.. (Default: true) - - useSwaggerUI - Add a route to /api which show your documentation in swagger-ui. Will also import needed dependencies (Default: true) - -Back to the [generators list](README.md) +--- +id: generator-opts-server-java-play-framework +title: Config Options for java-play-framework +sidebar_label: java-play-framework +--- + +| Option | Description | Values | Default | +| ------ | ----------- | ------ | ------- | +|sortParamsByRequiredFlag|Sort method arguments 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| +|prependFormOrBodyParameters|Add form or body parameters to the beginning of the parameter list.| |false| +|modelPackage|package for generated models| |null| +|apiPackage|package for generated api classes| |null| +|invokerPackage|root package for generated code| |null| +|groupId|groupId in generated pom.xml| |null| +|artifactId|artifactId in generated pom.xml| |null| +|artifactVersion|artifact version in generated pom.xml| |null| +|artifactUrl|artifact URL in generated pom.xml| |null| +|artifactDescription|artifact description in generated pom.xml| |null| +|scmConnection|SCM connection in generated pom.xml| |null| +|scmDeveloperConnection|SCM developer connection in generated pom.xml| |null| +|scmUrl|SCM URL in generated pom.xml| |null| +|developerName|developer name in generated pom.xml| |null| +|developerEmail|developer email in generated pom.xml| |null| +|developerOrganization|developer organization in generated pom.xml| |null| +|developerOrganizationUrl|developer organization URL in generated pom.xml| |null| +|licenseName|The name of the license| |null| +|licenseUrl|The URL of the license| |null| +|sourceFolder|source folder for generated code| |null| +|localVariablePrefix|prefix for generated code members and local variables| |null| +|serializableModel|boolean - toggle "implements Serializable" for generated models| |false| +|bigDecimalAsString|Treat BigDecimal values as Strings to avoid precision loss.| |false| +|fullJavaUtil|whether to use fully qualified name for classes under java.util. This option only works for Java API client| |false| +|hideGenerationTimestamp|hides the timestamp when files were generated| |null| +|withXml|whether to include support for application/xml content type and include XML annotations in the model (works with libraries that provide support for JSON and XML)| |false| +|dateLibrary|Option. Date library to use|
**joda**
Joda (for legacy app only)
**legacy**
Legacy java.util.Date (if you really have a good reason not to use threetenbp
**java8-localdatetime**
Java 8 using LocalDateTime (for legacy app only)
**java8**
Java 8 native JSR310 (preferred for jdk 1.8+) - note: this also sets "java8" to true
**threetenbp**
Backport of JSR310 (preferred for jdk < 1.8)
|null| +|java8|Option. Use Java8 classes instead of third party equivalents|
**true**
Use Java 8 classes such as Base64
**false**
Various third party libraries as needed
|null| +|disableHtmlEscaping|Disable HTML escaping of JSON strings when using gson (needed to avoid problems with byte[] fields)| |false| +|booleanGetterPrefix|Set booleanGetterPrefix (default value 'get')| |null| +|parentGroupId|parent groupId in generated pom N.B. parentGroupId, parentArtifactId and parentVersion must all be specified for any of them to take effect| |null| +|parentArtifactId|parent artifactId in generated pom N.B. parentGroupId, parentArtifactId and parentVersion must all be specified for any of them to take effect| |null| +|parentVersion|parent version in generated pom N.B. parentGroupId, parentArtifactId and parentVersion must all be specified for any of them to take effect| |null| +|title|server title name or client service name| |null| +|configPackage|configuration package for generated code| |null| +|basePackage|base package for generated code| |null| +|controllerOnly|Whether to generate only API interface stubs without the server files.| |false| +|useBeanValidation|Use BeanValidation API annotations| |true| +|useInterfaces|Makes the controllerImp implements an interface to facilitate automatic completion when updating from version x to y of your spec| |true| +|handleExceptions|Add a 'throw exception' to each controller function. Add also a custom error handler where you can put your custom logic| |true| +|wrapCalls|Add a wrapper to each controller function to handle things like metrics, response modification, etc..| |true| +|useSwaggerUI|Add a route to /api which show your documentation in swagger-ui. Will also import needed dependencies| |true| diff --git a/docs/generators/java-undertow-server.md b/docs/generators/java-undertow-server.md index facaf3aa8314..0f9ce1d77724 100644 --- a/docs/generators/java-undertow-server.md +++ b/docs/generators/java-undertow-server.md @@ -1,116 +1,44 @@ -CONFIG OPTIONS for java-undertow-server - - sortParamsByRequiredFlag - Sort method arguments to place required parameters before optional parameters. (Default: true) - - ensureUniqueParams - Whether to ensure parameter names are unique in an operation (rename parameters that are not). (Default: true) - - allowUnicodeIdentifiers - boolean, toggles whether unicode identifiers are allowed in names or not, default is false (Default: false) - - prependFormOrBodyParameters - Add form or body parameters to the beginning of the parameter list. (Default: false) - - modelPackage - package for generated models - - apiPackage - package for generated api classes - - invokerPackage - root package for generated code - - groupId - groupId in generated pom.xml - - artifactId - artifactId in generated pom.xml - - artifactVersion - artifact version in generated pom.xml - - artifactUrl - artifact URL in generated pom.xml - - artifactDescription - artifact description in generated pom.xml - - scmConnection - SCM connection in generated pom.xml - - scmDeveloperConnection - SCM developer connection in generated pom.xml - - scmUrl - SCM URL in generated pom.xml - - developerName - developer name in generated pom.xml - - developerEmail - developer email in generated pom.xml - - developerOrganization - developer organization in generated pom.xml - - developerOrganizationUrl - developer organization URL in generated pom.xml - - licenseName - The name of the license - - licenseUrl - The URL of the license - - sourceFolder - source folder for generated code - - localVariablePrefix - prefix for generated code members and local variables - - serializableModel - boolean - toggle "implements Serializable" for generated models (Default: false) - - bigDecimalAsString - Treat BigDecimal values as Strings to avoid precision loss. (Default: false) - - fullJavaUtil - whether to use fully qualified name for classes under java.util. This option only works for Java API client (Default: false) - - hideGenerationTimestamp - hides the timestamp when files were generated - - withXml - whether to include support for application/xml content type and include XML annotations in the model (works with libraries that provide support for JSON and XML) (Default: false) - - dateLibrary - Option. Date library to use - joda - Joda (for legacy app only) - legacy - Legacy java.util.Date (if you really have a good reason not to use threetenbp - java8-localdatetime - Java 8 using LocalDateTime (for legacy app only) - java8 - Java 8 native JSR310 (preferred for jdk 1.8+) - note: this also sets "java8" to true - threetenbp - Backport of JSR310 (preferred for jdk < 1.8) - - java8 - Option. Use Java8 classes instead of third party equivalents - true - Use Java 8 classes such as Base64 - false - Various third party libraries as needed - - disableHtmlEscaping - Disable HTML escaping of JSON strings when using gson (needed to avoid problems with byte[] fields) (Default: false) - - booleanGetterPrefix - Set booleanGetterPrefix (default value 'get') - - parentGroupId - parent groupId in generated pom N.B. parentGroupId, parentArtifactId and parentVersion must all be specified for any of them to take effect - - parentArtifactId - parent artifactId in generated pom N.B. parentGroupId, parentArtifactId and parentVersion must all be specified for any of them to take effect - - parentVersion - parent version in generated pom N.B. parentGroupId, parentArtifactId and parentVersion must all be specified for any of them to take effect - -Back to the [generators list](README.md) +--- +id: generator-opts-server-java-undertow-server +title: Config Options for java-undertow-server +sidebar_label: java-undertow-server +--- + +| Option | Description | Values | Default | +| ------ | ----------- | ------ | ------- | +|sortParamsByRequiredFlag|Sort method arguments 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| +|prependFormOrBodyParameters|Add form or body parameters to the beginning of the parameter list.| |false| +|modelPackage|package for generated models| |null| +|apiPackage|package for generated api classes| |null| +|invokerPackage|root package for generated code| |null| +|groupId|groupId in generated pom.xml| |null| +|artifactId|artifactId in generated pom.xml| |null| +|artifactVersion|artifact version in generated pom.xml| |null| +|artifactUrl|artifact URL in generated pom.xml| |null| +|artifactDescription|artifact description in generated pom.xml| |null| +|scmConnection|SCM connection in generated pom.xml| |null| +|scmDeveloperConnection|SCM developer connection in generated pom.xml| |null| +|scmUrl|SCM URL in generated pom.xml| |null| +|developerName|developer name in generated pom.xml| |null| +|developerEmail|developer email in generated pom.xml| |null| +|developerOrganization|developer organization in generated pom.xml| |null| +|developerOrganizationUrl|developer organization URL in generated pom.xml| |null| +|licenseName|The name of the license| |null| +|licenseUrl|The URL of the license| |null| +|sourceFolder|source folder for generated code| |null| +|localVariablePrefix|prefix for generated code members and local variables| |null| +|serializableModel|boolean - toggle "implements Serializable" for generated models| |false| +|bigDecimalAsString|Treat BigDecimal values as Strings to avoid precision loss.| |false| +|fullJavaUtil|whether to use fully qualified name for classes under java.util. This option only works for Java API client| |false| +|hideGenerationTimestamp|hides the timestamp when files were generated| |null| +|withXml|whether to include support for application/xml content type and include XML annotations in the model (works with libraries that provide support for JSON and XML)| |false| +|dateLibrary|Option. Date library to use|
**joda**
Joda (for legacy app only)
**legacy**
Legacy java.util.Date (if you really have a good reason not to use threetenbp
**java8-localdatetime**
Java 8 using LocalDateTime (for legacy app only)
**java8**
Java 8 native JSR310 (preferred for jdk 1.8+) - note: this also sets "java8" to true
**threetenbp**
Backport of JSR310 (preferred for jdk < 1.8)
|null| +|java8|Option. Use Java8 classes instead of third party equivalents|
**true**
Use Java 8 classes such as Base64
**false**
Various third party libraries as needed
|null| +|disableHtmlEscaping|Disable HTML escaping of JSON strings when using gson (needed to avoid problems with byte[] fields)| |false| +|booleanGetterPrefix|Set booleanGetterPrefix (default value 'get')| |null| +|parentGroupId|parent groupId in generated pom N.B. parentGroupId, parentArtifactId and parentVersion must all be specified for any of them to take effect| |null| +|parentArtifactId|parent artifactId in generated pom N.B. parentGroupId, parentArtifactId and parentVersion must all be specified for any of them to take effect| |null| +|parentVersion|parent version in generated pom N.B. parentGroupId, parentArtifactId and parentVersion must all be specified for any of them to take effect| |null| diff --git a/docs/generators/java-vertx.md b/docs/generators/java-vertx.md index 7a2099f101cb..a2e567030182 100644 --- a/docs/generators/java-vertx.md +++ b/docs/generators/java-vertx.md @@ -1,122 +1,46 @@ -CONFIG OPTIONS for java-vertx - - sortParamsByRequiredFlag - Sort method arguments to place required parameters before optional parameters. (Default: true) - - ensureUniqueParams - Whether to ensure parameter names are unique in an operation (rename parameters that are not). (Default: true) - - allowUnicodeIdentifiers - boolean, toggles whether unicode identifiers are allowed in names or not, default is false (Default: false) - - prependFormOrBodyParameters - Add form or body parameters to the beginning of the parameter list. (Default: false) - - modelPackage - package for generated models - - apiPackage - package for generated api classes - - invokerPackage - root package for generated code - - groupId - groupId in generated pom.xml - - artifactId - artifactId in generated pom.xml - - artifactVersion - artifact version in generated pom.xml - - artifactUrl - artifact URL in generated pom.xml - - artifactDescription - artifact description in generated pom.xml - - scmConnection - SCM connection in generated pom.xml - - scmDeveloperConnection - SCM developer connection in generated pom.xml - - scmUrl - SCM URL in generated pom.xml - - developerName - developer name in generated pom.xml - - developerEmail - developer email in generated pom.xml - - developerOrganization - developer organization in generated pom.xml - - developerOrganizationUrl - developer organization URL in generated pom.xml - - licenseName - The name of the license - - licenseUrl - The URL of the license - - sourceFolder - source folder for generated code - - localVariablePrefix - prefix for generated code members and local variables - - serializableModel - boolean - toggle "implements Serializable" for generated models (Default: false) - - bigDecimalAsString - Treat BigDecimal values as Strings to avoid precision loss. (Default: false) - - fullJavaUtil - whether to use fully qualified name for classes under java.util. This option only works for Java API client (Default: false) - - hideGenerationTimestamp - hides the timestamp when files were generated - - withXml - whether to include support for application/xml content type and include XML annotations in the model (works with libraries that provide support for JSON and XML) (Default: false) - - dateLibrary - Option. Date library to use - joda - Joda (for legacy app only) - legacy - Legacy java.util.Date (if you really have a good reason not to use threetenbp - java8-localdatetime - Java 8 using LocalDateTime (for legacy app only) - java8 - Java 8 native JSR310 (preferred for jdk 1.8+) - note: this also sets "java8" to true - threetenbp - Backport of JSR310 (preferred for jdk < 1.8) - - java8 - Option. Use Java8 classes instead of third party equivalents - true - Use Java 8 classes such as Base64 - false - Various third party libraries as needed - - disableHtmlEscaping - Disable HTML escaping of JSON strings when using gson (needed to avoid problems with byte[] fields) (Default: false) - - booleanGetterPrefix - Set booleanGetterPrefix (default value 'get') - - parentGroupId - parent groupId in generated pom N.B. parentGroupId, parentArtifactId and parentVersion must all be specified for any of them to take effect - - parentArtifactId - parent artifactId in generated pom N.B. parentGroupId, parentArtifactId and parentVersion must all be specified for any of them to take effect - - parentVersion - parent version in generated pom N.B. parentGroupId, parentArtifactId and parentVersion must all be specified for any of them to take effect - - rxInterface - When specified, API interfaces are generated with RX and methods return Single<> and Comparable. (Default: false) - - vertxSwaggerRouterVersion - Specify the version of the swagger router library - -Back to the [generators list](README.md) +--- +id: generator-opts-server-java-vertx +title: Config Options for java-vertx +sidebar_label: java-vertx +--- + +| Option | Description | Values | Default | +| ------ | ----------- | ------ | ------- | +|sortParamsByRequiredFlag|Sort method arguments 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| +|prependFormOrBodyParameters|Add form or body parameters to the beginning of the parameter list.| |false| +|modelPackage|package for generated models| |null| +|apiPackage|package for generated api classes| |null| +|invokerPackage|root package for generated code| |null| +|groupId|groupId in generated pom.xml| |null| +|artifactId|artifactId in generated pom.xml| |null| +|artifactVersion|artifact version in generated pom.xml| |null| +|artifactUrl|artifact URL in generated pom.xml| |null| +|artifactDescription|artifact description in generated pom.xml| |null| +|scmConnection|SCM connection in generated pom.xml| |null| +|scmDeveloperConnection|SCM developer connection in generated pom.xml| |null| +|scmUrl|SCM URL in generated pom.xml| |null| +|developerName|developer name in generated pom.xml| |null| +|developerEmail|developer email in generated pom.xml| |null| +|developerOrganization|developer organization in generated pom.xml| |null| +|developerOrganizationUrl|developer organization URL in generated pom.xml| |null| +|licenseName|The name of the license| |null| +|licenseUrl|The URL of the license| |null| +|sourceFolder|source folder for generated code| |null| +|localVariablePrefix|prefix for generated code members and local variables| |null| +|serializableModel|boolean - toggle "implements Serializable" for generated models| |false| +|bigDecimalAsString|Treat BigDecimal values as Strings to avoid precision loss.| |false| +|fullJavaUtil|whether to use fully qualified name for classes under java.util. This option only works for Java API client| |false| +|hideGenerationTimestamp|hides the timestamp when files were generated| |null| +|withXml|whether to include support for application/xml content type and include XML annotations in the model (works with libraries that provide support for JSON and XML)| |false| +|dateLibrary|Option. Date library to use|
**joda**
Joda (for legacy app only)
**legacy**
Legacy java.util.Date (if you really have a good reason not to use threetenbp
**java8-localdatetime**
Java 8 using LocalDateTime (for legacy app only)
**java8**
Java 8 native JSR310 (preferred for jdk 1.8+) - note: this also sets "java8" to true
**threetenbp**
Backport of JSR310 (preferred for jdk < 1.8)
|null| +|java8|Option. Use Java8 classes instead of third party equivalents|
**true**
Use Java 8 classes such as Base64
**false**
Various third party libraries as needed
|null| +|disableHtmlEscaping|Disable HTML escaping of JSON strings when using gson (needed to avoid problems with byte[] fields)| |false| +|booleanGetterPrefix|Set booleanGetterPrefix (default value 'get')| |null| +|parentGroupId|parent groupId in generated pom N.B. parentGroupId, parentArtifactId and parentVersion must all be specified for any of them to take effect| |null| +|parentArtifactId|parent artifactId in generated pom N.B. parentGroupId, parentArtifactId and parentVersion must all be specified for any of them to take effect| |null| +|parentVersion|parent version in generated pom N.B. parentGroupId, parentArtifactId and parentVersion must all be specified for any of them to take effect| |null| +|rxInterface|When specified, API interfaces are generated with RX and methods return Single<> and Comparable.| |false| +|vertxSwaggerRouterVersion|Specify the version of the swagger router library| |null| diff --git a/docs/generators/java.md b/docs/generators/java.md index 01942712ab38..aa63cacf4b46 100644 --- a/docs/generators/java.md +++ b/docs/generators/java.md @@ -1,164 +1,56 @@ -CONFIG OPTIONS for java - - sortParamsByRequiredFlag - Sort method arguments to place required parameters before optional parameters. (Default: true) - - ensureUniqueParams - Whether to ensure parameter names are unique in an operation (rename parameters that are not). (Default: true) - - allowUnicodeIdentifiers - boolean, toggles whether unicode identifiers are allowed in names or not, default is false (Default: false) - - prependFormOrBodyParameters - Add form or body parameters to the beginning of the parameter list. (Default: false) - - modelPackage - package for generated models - - apiPackage - package for generated api classes - - invokerPackage - root package for generated code - - groupId - groupId in generated pom.xml - - artifactId - artifactId in generated pom.xml - - artifactVersion - artifact version in generated pom.xml - - artifactUrl - artifact URL in generated pom.xml - - artifactDescription - artifact description in generated pom.xml - - scmConnection - SCM connection in generated pom.xml - - scmDeveloperConnection - SCM developer connection in generated pom.xml - - scmUrl - SCM URL in generated pom.xml - - developerName - developer name in generated pom.xml - - developerEmail - developer email in generated pom.xml - - developerOrganization - developer organization in generated pom.xml - - developerOrganizationUrl - developer organization URL in generated pom.xml - - licenseName - The name of the license - - licenseUrl - The URL of the license - - sourceFolder - source folder for generated code - - localVariablePrefix - prefix for generated code members and local variables - - serializableModel - boolean - toggle "implements Serializable" for generated models (Default: false) - - bigDecimalAsString - Treat BigDecimal values as Strings to avoid precision loss. (Default: false) - - fullJavaUtil - whether to use fully qualified name for classes under java.util. This option only works for Java API client (Default: false) - - hideGenerationTimestamp - hides the timestamp when files were generated - - withXml - whether to include support for application/xml content type and include XML annotations in the model (works with libraries that provide support for JSON and XML) (Default: false) - - dateLibrary - Option. Date library to use - joda - Joda (for legacy app only) - legacy - Legacy java.util.Date (if you really have a good reason not to use threetenbp - java8-localdatetime - Java 8 using LocalDateTime (for legacy app only) - java8 - Java 8 native JSR310 (preferred for jdk 1.8+) - note: this also sets "java8" to true - threetenbp - Backport of JSR310 (preferred for jdk < 1.8) - - java8 - Option. Use Java8 classes instead of third party equivalents - true - Use Java 8 classes such as Base64 - false - Various third party libraries as needed - - disableHtmlEscaping - Disable HTML escaping of JSON strings when using gson (needed to avoid problems with byte[] fields) (Default: false) - - booleanGetterPrefix - Set booleanGetterPrefix (default value 'get') - - parentGroupId - parent groupId in generated pom N.B. parentGroupId, parentArtifactId and parentVersion must all be specified for any of them to take effect - - parentArtifactId - parent artifactId in generated pom N.B. parentGroupId, parentArtifactId and parentVersion must all be specified for any of them to take effect - - parentVersion - parent version in generated pom N.B. parentGroupId, parentArtifactId and parentVersion must all be specified for any of them to take effect - - useRxJava - Whether to use the RxJava adapter with the retrofit2 library. (Default: false) - - useRxJava2 - Whether to use the RxJava2 adapter with the retrofit2 library. (Default: false) - - parcelableModel - Whether to generate models for Android that implement Parcelable with the okhttp-gson library. (Default: false) - - usePlayWS - Use Play! Async HTTP client (Play WS API) (Default: false) - - playVersion - Version of Play! Framework (possible values "play24", "play25" (default), "play26") - - supportJava6 - Whether to support Java6 with the Jersey1 library. (Default: false) - - useBeanValidation - Use BeanValidation API annotations (Default: false) - - performBeanValidation - Perform BeanValidation (Default: false) - - useGzipFeature - Send gzip-encoded requests (Default: false) - - useRuntimeException - Use RuntimeException instead of Exception (Default: false) - - feignVersion - Version of OpenFeign: '10.x', '9.x' (default) (Default: false) - - library - library template (sub-template) to use (Default: okhttp-gson) - jersey1 - HTTP client: Jersey client 1.19.4. JSON processing: Jackson 2.8.9. Enable Java6 support using '-DsupportJava6=true'. Enable gzip request encoding using '-DuseGzipFeature=true'. - feign - HTTP client: OpenFeign 9.4.0. JSON processing: Jackson 2.8.9. To enable OpenFeign 10.x, set the 'feignVersion' option to '10.x' - jersey2 - HTTP client: Jersey client 2.25.1. JSON processing: Jackson 2.8.9 - okhttp-gson - HTTP client: OkHttp 2.7.5. JSON processing: Gson 2.8.1. Enable Parcelable models on Android using '-DparcelableModel=true'. Enable gzip request encoding using '-DuseGzipFeature=true'. - retrofit - HTTP client: OkHttp 2.7.5. JSON processing: Gson 2.3.1 (Retrofit 1.9.0). IMPORTANT NOTE: retrofit1.x is no longer actively maintained so please upgrade to 'retrofit2' instead. - retrofit2 - HTTP client: OkHttp 3.8.0. JSON processing: Gson 2.6.1 (Retrofit 2.3.0). Enable the RxJava adapter using '-DuseRxJava[2]=true'. (RxJava 1.x or 2.x) - resttemplate - HTTP client: Spring RestTemplate 4.3.9-RELEASE. JSON processing: Jackson 2.8.9 - webclient - HTTP client: Spring WebClient 5.0.7-RELEASE. JSON processing: Jackson 2.9.5 - resteasy - HTTP client: Resteasy client 3.1.3.Final. JSON processing: Jackson 2.8.9 - vertx - HTTP client: VertX client 3.2.4. JSON processing: Jackson 2.8.9 - google-api-client - HTTP client: Google API client 1.23.0. JSON processing: Jackson 2.8.9 - rest-assured - HTTP client: rest-assured : 3.1.0. JSON processing: Gson 2.6.1. Only for Java8 - -Back to the [generators list](README.md) +--- +id: generator-opts-client-java +title: Config Options for java +sidebar_label: java +--- + +| Option | Description | Values | Default | +| ------ | ----------- | ------ | ------- | +|sortParamsByRequiredFlag|Sort method arguments 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| +|prependFormOrBodyParameters|Add form or body parameters to the beginning of the parameter list.| |false| +|modelPackage|package for generated models| |null| +|apiPackage|package for generated api classes| |null| +|invokerPackage|root package for generated code| |null| +|groupId|groupId in generated pom.xml| |null| +|artifactId|artifactId in generated pom.xml| |null| +|artifactVersion|artifact version in generated pom.xml| |null| +|artifactUrl|artifact URL in generated pom.xml| |null| +|artifactDescription|artifact description in generated pom.xml| |null| +|scmConnection|SCM connection in generated pom.xml| |null| +|scmDeveloperConnection|SCM developer connection in generated pom.xml| |null| +|scmUrl|SCM URL in generated pom.xml| |null| +|developerName|developer name in generated pom.xml| |null| +|developerEmail|developer email in generated pom.xml| |null| +|developerOrganization|developer organization in generated pom.xml| |null| +|developerOrganizationUrl|developer organization URL in generated pom.xml| |null| +|licenseName|The name of the license| |null| +|licenseUrl|The URL of the license| |null| +|sourceFolder|source folder for generated code| |null| +|localVariablePrefix|prefix for generated code members and local variables| |null| +|serializableModel|boolean - toggle "implements Serializable" for generated models| |false| +|bigDecimalAsString|Treat BigDecimal values as Strings to avoid precision loss.| |false| +|fullJavaUtil|whether to use fully qualified name for classes under java.util. This option only works for Java API client| |false| +|hideGenerationTimestamp|hides the timestamp when files were generated| |null| +|withXml|whether to include support for application/xml content type and include XML annotations in the model (works with libraries that provide support for JSON and XML)| |false| +|dateLibrary|Option. Date library to use|
**joda**
Joda (for legacy app only)
**legacy**
Legacy java.util.Date (if you really have a good reason not to use threetenbp
**java8-localdatetime**
Java 8 using LocalDateTime (for legacy app only)
**java8**
Java 8 native JSR310 (preferred for jdk 1.8+) - note: this also sets "java8" to true
**threetenbp**
Backport of JSR310 (preferred for jdk < 1.8)
|null| +|java8|Option. Use Java8 classes instead of third party equivalents|
**true**
Use Java 8 classes such as Base64
**false**
Various third party libraries as needed
|null| +|disableHtmlEscaping|Disable HTML escaping of JSON strings when using gson (needed to avoid problems with byte[] fields)| |false| +|booleanGetterPrefix|Set booleanGetterPrefix (default value 'get')| |null| +|parentGroupId|parent groupId in generated pom N.B. parentGroupId, parentArtifactId and parentVersion must all be specified for any of them to take effect| |null| +|parentArtifactId|parent artifactId in generated pom N.B. parentGroupId, parentArtifactId and parentVersion must all be specified for any of them to take effect| |null| +|parentVersion|parent version in generated pom N.B. parentGroupId, parentArtifactId and parentVersion must all be specified for any of them to take effect| |null| +|useRxJava|Whether to use the RxJava adapter with the retrofit2 library.| |false| +|useRxJava2|Whether to use the RxJava2 adapter with the retrofit2 library.| |false| +|parcelableModel|Whether to generate models for Android that implement Parcelable with the okhttp-gson library.| |false| +|usePlayWS|Use Play! Async HTTP client (Play WS API)| |false| +|playVersion|Version of Play! Framework (possible values "play24", "play25" (default), "play26")| |null| +|supportJava6|Whether to support Java6 with the Jersey1 library.| |false| +|useBeanValidation|Use BeanValidation API annotations| |false| +|performBeanValidation|Perform BeanValidation| |false| +|useGzipFeature|Send gzip-encoded requests| |false| +|useRuntimeException|Use RuntimeException instead of Exception| |false| +|feignVersion|Version of OpenFeign: '10.x', '9.x' (default)| |false| +|library|library template (sub-template) to use|
**jersey1**
HTTP client: Jersey client 1.19.4. JSON processing: Jackson 2.8.9. Enable Java6 support using '-DsupportJava6=true'. Enable gzip request encoding using '-DuseGzipFeature=true'.
**feign**
HTTP client: OpenFeign 9.4.0. JSON processing: Jackson 2.8.9. To enable OpenFeign 10.x, set the 'feignVersion' option to '10.x'
**jersey2**
HTTP client: Jersey client 2.25.1. JSON processing: Jackson 2.8.9
**okhttp-gson**
HTTP client: OkHttp 2.7.5. JSON processing: Gson 2.8.1. Enable Parcelable models on Android using '-DparcelableModel=true'. Enable gzip request encoding using '-DuseGzipFeature=true'.
**retrofit**
HTTP client: OkHttp 2.7.5. JSON processing: Gson 2.3.1 (Retrofit 1.9.0). IMPORTANT NOTE: retrofit1.x is no longer actively maintained so please upgrade to 'retrofit2' instead.
**retrofit2**
HTTP client: OkHttp 3.8.0. JSON processing: Gson 2.6.1 (Retrofit 2.3.0). Enable the RxJava adapter using '-DuseRxJava[2]=true'. (RxJava 1.x or 2.x)
**resttemplate**
HTTP client: Spring RestTemplate 4.3.9-RELEASE. JSON processing: Jackson 2.8.9
**webclient**
HTTP client: Spring WebClient 5.0.7-RELEASE. JSON processing: Jackson 2.9.5
**resteasy**
HTTP client: Resteasy client 3.1.3.Final. JSON processing: Jackson 2.8.9
**vertx**
HTTP client: VertX client 3.2.4. JSON processing: Jackson 2.8.9
**google-api-client**
HTTP client: Google API client 1.23.0. JSON processing: Jackson 2.8.9
**rest-assured**
HTTP client: rest-assured : 3.1.0. JSON processing: Gson 2.6.1. Only for Java8
|okhttp-gson| diff --git a/docs/generators/javascript-closure-angular.md b/docs/generators/javascript-closure-angular.md index 69f68a358409..eef6edb7c79e 100644 --- a/docs/generators/javascript-closure-angular.md +++ b/docs/generators/javascript-closure-angular.md @@ -1,22 +1,15 @@ -CONFIG OPTIONS for javascript-closure-angular - - sortParamsByRequiredFlag - Sort method arguments to place required parameters before optional parameters. (Default: true) - - ensureUniqueParams - Whether to ensure parameter names are unique in an operation (rename parameters that are not). (Default: true) - - allowUnicodeIdentifiers - boolean, toggles whether unicode identifiers are allowed in names or not, default is false (Default: false) - - prependFormOrBodyParameters - Add form or body parameters to the beginning of the parameter list. (Default: false) - - hideGenerationTimestamp - Hides the generation timestamp when files are generated. (Default: true) - - useEs6 - use ES6 templates (Default: false) - -Back to the [generators list](README.md) +--- +id: generator-opts-client-javascript-closure-angular +title: Config Options for javascript-closure-angular +sidebar_label: javascript-closure-angular +--- + +| Option | Description | Values | Default | +| ------ | ----------- | ------ | ------- | +|sortParamsByRequiredFlag|Sort method arguments 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| +|prependFormOrBodyParameters|Add form or body parameters to the beginning of the parameter list.| |false| +|hideGenerationTimestamp|Hides the generation timestamp when files are generated.| |true| +|useEs6|use ES6 templates| |false| diff --git a/docs/generators/javascript-flowtyped.md b/docs/generators/javascript-flowtyped.md index 242bde622388..831f5c1586bd 100644 --- a/docs/generators/javascript-flowtyped.md +++ b/docs/generators/javascript-flowtyped.md @@ -1,34 +1,19 @@ -CONFIG OPTIONS for javascript-flowtyped - - sortParamsByRequiredFlag - Sort method arguments to place required parameters before optional parameters. (Default: true) - - ensureUniqueParams - Whether to ensure parameter names are unique in an operation (rename parameters that are not). (Default: true) - - allowUnicodeIdentifiers - boolean, toggles whether unicode identifiers are allowed in names or not, default is false (Default: false) - - prependFormOrBodyParameters - Add form or body parameters to the beginning of the parameter list. (Default: false) - - modelPropertyNaming - Naming convention for the property: 'camelCase', 'PascalCase', 'snake_case' and 'original', which keeps the original name (Default: camelCase) - - supportsES6 - Generate code that conforms to ES6. (Default: false) - - npmName - The name under which you want to publish generated npm package - - npmVersion - The version of your npm package - - npmRepository - Use this property to set an url your private npmRepo in the package.json - - snapshot - When setting this property to true the version will be suffixed with -SNAPSHOT.yyyyMMddHHmm (Default: false) - -Back to the [generators list](README.md) +--- +id: generator-opts-client-javascript-flowtyped +title: Config Options for javascript-flowtyped +sidebar_label: javascript-flowtyped +--- + +| Option | Description | Values | Default | +| ------ | ----------- | ------ | ------- | +|sortParamsByRequiredFlag|Sort method arguments 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| +|prependFormOrBodyParameters|Add form or body parameters to the beginning of the parameter list.| |false| +|modelPropertyNaming|Naming convention for the property: 'camelCase', 'PascalCase', 'snake_case' and 'original', which keeps the original name| |camelCase| +|supportsES6|Generate code that conforms to ES6.| |false| +|npmName|The name under which you want to publish generated npm package| |null| +|npmVersion|The version of your npm package| |null| +|npmRepository|Use this property to set an url your private npmRepo in the package.json| |null| +|snapshot|When setting this property to true the version will be suffixed with -SNAPSHOT.yyyyMMddHHmm| |false| diff --git a/docs/generators/javascript.md b/docs/generators/javascript.md index e8d9df4c650a..f9e8b0ad47fb 100644 --- a/docs/generators/javascript.md +++ b/docs/generators/javascript.md @@ -1,67 +1,30 @@ -CONFIG OPTIONS for javascript - - sortParamsByRequiredFlag - Sort method arguments to place required parameters before optional parameters. (Default: true) - - ensureUniqueParams - Whether to ensure parameter names are unique in an operation (rename parameters that are not). (Default: true) - - allowUnicodeIdentifiers - boolean, toggles whether unicode identifiers are allowed in names or not, default is false (Default: false) - - prependFormOrBodyParameters - Add form or body parameters to the beginning of the parameter list. (Default: false) - - sourceFolder - source folder for generated code (Default: src) - - localVariablePrefix - prefix for generated code members and local variables - - invokerPackage - root package for generated code - - apiPackage - package for generated api classes - - modelPackage - package for generated models - - projectName - name of the project (Default: generated from info.title or "openapi-js-client") - - moduleName - module name for AMD, Node or globals (Default: generated from ) - - projectDescription - description of the project (Default: using info.description or "Client library of ") - - projectVersion - version of the project (Default: using info.version or "1.0.0") - - licenseName - name of the license the project uses (Default: using info.license.name) - - usePromises - use Promises as return values from the client API, instead of superagent callbacks (Default: false) - - emitModelMethods - generate getters and setters for model properties (Default: false) - - emitJSDoc - generate JSDoc comments (Default: true) - - useInheritance - use JavaScript prototype chains & delegation for inheritance (Default: true) - - hideGenerationTimestamp - Hides the generation timestamp when files are generated. (Default: true) - - useES6 - use JavaScript ES6 (ECMAScript 6) (beta). Default is ES5. (Default: false) - - modelPropertyNaming - Naming convention for the property: 'camelCase', 'PascalCase', 'snake_case' and 'original', which keeps the original name (Default: camelCase) - -Back to the [generators list](README.md) +--- +id: generator-opts-client-javascript +title: Config Options for javascript +sidebar_label: javascript +--- + +| Option | Description | Values | Default | +| ------ | ----------- | ------ | ------- | +|sortParamsByRequiredFlag|Sort method arguments 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| +|prependFormOrBodyParameters|Add form or body parameters to the beginning of the parameter list.| |false| +|sourceFolder|source folder for generated code| |src| +|localVariablePrefix|prefix for generated code members and local variables| |null| +|invokerPackage|root package for generated code| |null| +|apiPackage|package for generated api classes| |null| +|modelPackage|package for generated models| |null| +|projectName|name of the project (Default: generated from info.title or "openapi-js-client")| |null| +|moduleName|module name for AMD, Node or globals (Default: generated from <projectName>)| |null| +|projectDescription|description of the project (Default: using info.description or "Client library of <projectName>")| |null| +|projectVersion|version of the project (Default: using info.version or "1.0.0")| |null| +|licenseName|name of the license the project uses (Default: using info.license.name)| |null| +|usePromises|use Promises as return values from the client API, instead of superagent callbacks| |false| +|emitModelMethods|generate getters and setters for model properties| |false| +|emitJSDoc|generate JSDoc comments| |true| +|useInheritance|use JavaScript prototype chains & delegation for inheritance| |true| +|hideGenerationTimestamp|Hides the generation timestamp when files are generated.| |true| +|useES6|use JavaScript ES6 (ECMAScript 6) (beta). Default is ES5.| |false| +|modelPropertyNaming|Naming convention for the property: 'camelCase', 'PascalCase', 'snake_case' and 'original', which keeps the original name| |camelCase| diff --git a/docs/generators/jaxrs-cxf-cdi.md b/docs/generators/jaxrs-cxf-cdi.md index 6f29fc108684..aaab6233b0fc 100644 --- a/docs/generators/jaxrs-cxf-cdi.md +++ b/docs/generators/jaxrs-cxf-cdi.md @@ -1,147 +1,54 @@ -CONFIG OPTIONS for jaxrs-cxf-cdi - - sortParamsByRequiredFlag - Sort method arguments to place required parameters before optional parameters. (Default: true) - - ensureUniqueParams - Whether to ensure parameter names are unique in an operation (rename parameters that are not). (Default: true) - - allowUnicodeIdentifiers - boolean, toggles whether unicode identifiers are allowed in names or not, default is false (Default: false) - - prependFormOrBodyParameters - Add form or body parameters to the beginning of the parameter list. (Default: false) - - modelPackage - package for generated models - - apiPackage - package for generated api classes - - invokerPackage - root package for generated code - - groupId - groupId in generated pom.xml - - artifactId - artifactId in generated pom.xml - - artifactVersion - artifact version in generated pom.xml - - artifactUrl - artifact URL in generated pom.xml - - artifactDescription - artifact description in generated pom.xml - - scmConnection - SCM connection in generated pom.xml - - scmDeveloperConnection - SCM developer connection in generated pom.xml - - scmUrl - SCM URL in generated pom.xml - - developerName - developer name in generated pom.xml - - developerEmail - developer email in generated pom.xml - - developerOrganization - developer organization in generated pom.xml - - developerOrganizationUrl - developer organization URL in generated pom.xml - - licenseName - The name of the license - - licenseUrl - The URL of the license - - sourceFolder - source folder for generated code - - localVariablePrefix - prefix for generated code members and local variables - - serializableModel - boolean - toggle "implements Serializable" for generated models (Default: false) - - bigDecimalAsString - Treat BigDecimal values as Strings to avoid precision loss. (Default: false) - - fullJavaUtil - whether to use fully qualified name for classes under java.util. This option only works for Java API client (Default: false) - - hideGenerationTimestamp - hides the timestamp when files were generated - - withXml - whether to include support for application/xml content type and include XML annotations in the model (works with libraries that provide support for JSON and XML) (Default: false) - - dateLibrary - Option. Date library to use - joda - Joda (for legacy app only) - legacy - Legacy java.util.Date (if you really have a good reason not to use threetenbp - java8-localdatetime - Java 8 using LocalDateTime (for legacy app only) - java8 - Java 8 native JSR310 (preferred for jdk 1.8+) - note: this also sets "java8" to true - threetenbp - Backport of JSR310 (preferred for jdk < 1.8) - - java8 - Option. Use Java8 classes instead of third party equivalents - true - Use Java 8 classes such as Base64 - false - Various third party libraries as needed - - disableHtmlEscaping - Disable HTML escaping of JSON strings when using gson (needed to avoid problems with byte[] fields) (Default: false) - - booleanGetterPrefix - Set booleanGetterPrefix (default value 'get') - - parentGroupId - parent groupId in generated pom N.B. parentGroupId, parentArtifactId and parentVersion must all be specified for any of them to take effect - - parentArtifactId - parent artifactId in generated pom N.B. parentGroupId, parentArtifactId and parentVersion must all be specified for any of them to take effect - - parentVersion - parent version in generated pom N.B. parentGroupId, parentArtifactId and parentVersion must all be specified for any of them to take effect - - implFolder - folder for generated implementation code - - title - a title describing the application - - useBeanValidation - Use BeanValidation API annotations (Default: true) - - serverPort - The port on which the server should be started - - library - library template (sub-template) to use (Default: ) - - JAXRS - - generatePom - Whether to generate pom.xml if the file does not already exist. (Default: true) - - interfaceOnly - Whether to generate only API interface stubs without the server files. (Default: false) - - returnResponse - Whether generate API interface should return javax.ws.rs.core.Response instead of a deserialized entity. Only useful if interfaceOnly is true. (Default: false) - - useSwaggerAnnotations - Whether to generate Swagger annotations. (Default: true) - - useBeanValidation - Use BeanValidation API annotations (Default: true) - -Back to the [generators list](README.md) +--- +id: generator-opts-server-jaxrs-cxf-cdi +title: Config Options for jaxrs-cxf-cdi +sidebar_label: jaxrs-cxf-cdi +--- + +| Option | Description | Values | Default | +| ------ | ----------- | ------ | ------- | +|sortParamsByRequiredFlag|Sort method arguments 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| +|prependFormOrBodyParameters|Add form or body parameters to the beginning of the parameter list.| |false| +|modelPackage|package for generated models| |null| +|apiPackage|package for generated api classes| |null| +|invokerPackage|root package for generated code| |null| +|groupId|groupId in generated pom.xml| |null| +|artifactId|artifactId in generated pom.xml| |null| +|artifactVersion|artifact version in generated pom.xml| |null| +|artifactUrl|artifact URL in generated pom.xml| |null| +|artifactDescription|artifact description in generated pom.xml| |null| +|scmConnection|SCM connection in generated pom.xml| |null| +|scmDeveloperConnection|SCM developer connection in generated pom.xml| |null| +|scmUrl|SCM URL in generated pom.xml| |null| +|developerName|developer name in generated pom.xml| |null| +|developerEmail|developer email in generated pom.xml| |null| +|developerOrganization|developer organization in generated pom.xml| |null| +|developerOrganizationUrl|developer organization URL in generated pom.xml| |null| +|licenseName|The name of the license| |null| +|licenseUrl|The URL of the license| |null| +|sourceFolder|source folder for generated code| |null| +|localVariablePrefix|prefix for generated code members and local variables| |null| +|serializableModel|boolean - toggle "implements Serializable" for generated models| |false| +|bigDecimalAsString|Treat BigDecimal values as Strings to avoid precision loss.| |false| +|fullJavaUtil|whether to use fully qualified name for classes under java.util. This option only works for Java API client| |false| +|hideGenerationTimestamp|hides the timestamp when files were generated| |null| +|withXml|whether to include support for application/xml content type and include XML annotations in the model (works with libraries that provide support for JSON and XML)| |false| +|dateLibrary|Option. Date library to use|
**joda**
Joda (for legacy app only)
**legacy**
Legacy java.util.Date (if you really have a good reason not to use threetenbp
**java8-localdatetime**
Java 8 using LocalDateTime (for legacy app only)
**java8**
Java 8 native JSR310 (preferred for jdk 1.8+) - note: this also sets "java8" to true
**threetenbp**
Backport of JSR310 (preferred for jdk < 1.8)
|null| +|java8|Option. Use Java8 classes instead of third party equivalents|
**true**
Use Java 8 classes such as Base64
**false**
Various third party libraries as needed
|null| +|disableHtmlEscaping|Disable HTML escaping of JSON strings when using gson (needed to avoid problems with byte[] fields)| |false| +|booleanGetterPrefix|Set booleanGetterPrefix (default value 'get')| |null| +|parentGroupId|parent groupId in generated pom N.B. parentGroupId, parentArtifactId and parentVersion must all be specified for any of them to take effect| |null| +|parentArtifactId|parent artifactId in generated pom N.B. parentGroupId, parentArtifactId and parentVersion must all be specified for any of them to take effect| |null| +|parentVersion|parent version in generated pom N.B. parentGroupId, parentArtifactId and parentVersion must all be specified for any of them to take effect| |null| +|implFolder|folder for generated implementation code| |null| +|title|a title describing the application| |null| +|useBeanValidation|Use BeanValidation API annotations| |true| +|serverPort|The port on which the server should be started| |null| +|library|library template (sub-template) to use|
**<default>**
JAXRS
|<default>| +|generatePom|Whether to generate pom.xml if the file does not already exist.| |true| +|interfaceOnly|Whether to generate only API interface stubs without the server files.| |false| +|returnResponse|Whether generate API interface should return javax.ws.rs.core.Response instead of a deserialized entity. Only useful if interfaceOnly is true.| |false| +|useSwaggerAnnotations|Whether to generate Swagger annotations.| |true| +|useBeanValidation|Use BeanValidation API annotations| |true| diff --git a/docs/generators/jaxrs-cxf-client.md b/docs/generators/jaxrs-cxf-client.md index df9f1d2b8af0..53309c560f89 100644 --- a/docs/generators/jaxrs-cxf-client.md +++ b/docs/generators/jaxrs-cxf-client.md @@ -1,128 +1,48 @@ -CONFIG OPTIONS for jaxrs-cxf-client - - sortParamsByRequiredFlag - Sort method arguments to place required parameters before optional parameters. (Default: true) - - ensureUniqueParams - Whether to ensure parameter names are unique in an operation (rename parameters that are not). (Default: true) - - allowUnicodeIdentifiers - boolean, toggles whether unicode identifiers are allowed in names or not, default is false (Default: false) - - prependFormOrBodyParameters - Add form or body parameters to the beginning of the parameter list. (Default: false) - - modelPackage - package for generated models - - apiPackage - package for generated api classes - - invokerPackage - root package for generated code - - groupId - groupId in generated pom.xml - - artifactId - artifactId in generated pom.xml - - artifactVersion - artifact version in generated pom.xml - - artifactUrl - artifact URL in generated pom.xml - - artifactDescription - artifact description in generated pom.xml - - scmConnection - SCM connection in generated pom.xml - - scmDeveloperConnection - SCM developer connection in generated pom.xml - - scmUrl - SCM URL in generated pom.xml - - developerName - developer name in generated pom.xml - - developerEmail - developer email in generated pom.xml - - developerOrganization - developer organization in generated pom.xml - - developerOrganizationUrl - developer organization URL in generated pom.xml - - licenseName - The name of the license - - licenseUrl - The URL of the license - - sourceFolder - source folder for generated code - - localVariablePrefix - prefix for generated code members and local variables - - serializableModel - boolean - toggle "implements Serializable" for generated models (Default: false) - - bigDecimalAsString - Treat BigDecimal values as Strings to avoid precision loss. (Default: false) - - fullJavaUtil - whether to use fully qualified name for classes under java.util. This option only works for Java API client (Default: false) - - hideGenerationTimestamp - hides the timestamp when files were generated - - withXml - whether to include support for application/xml content type and include XML annotations in the model (works with libraries that provide support for JSON and XML) (Default: false) - - dateLibrary - Option. Date library to use - joda - Joda (for legacy app only) - legacy - Legacy java.util.Date (if you really have a good reason not to use threetenbp - java8-localdatetime - Java 8 using LocalDateTime (for legacy app only) - java8 - Java 8 native JSR310 (preferred for jdk 1.8+) - note: this also sets "java8" to true - threetenbp - Backport of JSR310 (preferred for jdk < 1.8) - - java8 - Option. Use Java8 classes instead of third party equivalents - true - Use Java 8 classes such as Base64 - false - Various third party libraries as needed - - disableHtmlEscaping - Disable HTML escaping of JSON strings when using gson (needed to avoid problems with byte[] fields) (Default: false) - - booleanGetterPrefix - Set booleanGetterPrefix (default value 'get') - - parentGroupId - parent groupId in generated pom N.B. parentGroupId, parentArtifactId and parentVersion must all be specified for any of them to take effect - - parentArtifactId - parent artifactId in generated pom N.B. parentGroupId, parentArtifactId and parentVersion must all be specified for any of them to take effect - - parentVersion - parent version in generated pom N.B. parentGroupId, parentArtifactId and parentVersion must all be specified for any of them to take effect - - useBeanValidation - Use BeanValidation API annotations (Default: false) - - useGzipFeatureForTests - Use Gzip Feature for tests (Default: false) - - useLoggingFeatureForTests - Use Logging Feature for tests (Default: false) - - useGenericResponse - Use generic response (Default: false) - -Back to the [generators list](README.md) +--- +id: generator-opts-client-jaxrs-cxf-client +title: Config Options for jaxrs-cxf-client +sidebar_label: jaxrs-cxf-client +--- + +| Option | Description | Values | Default | +| ------ | ----------- | ------ | ------- | +|sortParamsByRequiredFlag|Sort method arguments 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| +|prependFormOrBodyParameters|Add form or body parameters to the beginning of the parameter list.| |false| +|modelPackage|package for generated models| |null| +|apiPackage|package for generated api classes| |null| +|invokerPackage|root package for generated code| |null| +|groupId|groupId in generated pom.xml| |null| +|artifactId|artifactId in generated pom.xml| |null| +|artifactVersion|artifact version in generated pom.xml| |null| +|artifactUrl|artifact URL in generated pom.xml| |null| +|artifactDescription|artifact description in generated pom.xml| |null| +|scmConnection|SCM connection in generated pom.xml| |null| +|scmDeveloperConnection|SCM developer connection in generated pom.xml| |null| +|scmUrl|SCM URL in generated pom.xml| |null| +|developerName|developer name in generated pom.xml| |null| +|developerEmail|developer email in generated pom.xml| |null| +|developerOrganization|developer organization in generated pom.xml| |null| +|developerOrganizationUrl|developer organization URL in generated pom.xml| |null| +|licenseName|The name of the license| |null| +|licenseUrl|The URL of the license| |null| +|sourceFolder|source folder for generated code| |null| +|localVariablePrefix|prefix for generated code members and local variables| |null| +|serializableModel|boolean - toggle "implements Serializable" for generated models| |false| +|bigDecimalAsString|Treat BigDecimal values as Strings to avoid precision loss.| |false| +|fullJavaUtil|whether to use fully qualified name for classes under java.util. This option only works for Java API client| |false| +|hideGenerationTimestamp|hides the timestamp when files were generated| |null| +|withXml|whether to include support for application/xml content type and include XML annotations in the model (works with libraries that provide support for JSON and XML)| |false| +|dateLibrary|Option. Date library to use|
**joda**
Joda (for legacy app only)
**legacy**
Legacy java.util.Date (if you really have a good reason not to use threetenbp
**java8-localdatetime**
Java 8 using LocalDateTime (for legacy app only)
**java8**
Java 8 native JSR310 (preferred for jdk 1.8+) - note: this also sets "java8" to true
**threetenbp**
Backport of JSR310 (preferred for jdk < 1.8)
|null| +|java8|Option. Use Java8 classes instead of third party equivalents|
**true**
Use Java 8 classes such as Base64
**false**
Various third party libraries as needed
|null| +|disableHtmlEscaping|Disable HTML escaping of JSON strings when using gson (needed to avoid problems with byte[] fields)| |false| +|booleanGetterPrefix|Set booleanGetterPrefix (default value 'get')| |null| +|parentGroupId|parent groupId in generated pom N.B. parentGroupId, parentArtifactId and parentVersion must all be specified for any of them to take effect| |null| +|parentArtifactId|parent artifactId in generated pom N.B. parentGroupId, parentArtifactId and parentVersion must all be specified for any of them to take effect| |null| +|parentVersion|parent version in generated pom N.B. parentGroupId, parentArtifactId and parentVersion must all be specified for any of them to take effect| |null| +|useBeanValidation|Use BeanValidation API annotations| |false| +|useGzipFeatureForTests|Use Gzip Feature for tests| |false| +|useLoggingFeatureForTests|Use Logging Feature for tests| |false| +|useGenericResponse|Use generic response| |false| diff --git a/docs/generators/jaxrs-cxf.md b/docs/generators/jaxrs-cxf.md index 4fce66ff8dc8..93ce3dfb310f 100644 --- a/docs/generators/jaxrs-cxf.md +++ b/docs/generators/jaxrs-cxf.md @@ -1,179 +1,65 @@ -CONFIG OPTIONS for jaxrs-cxf - - sortParamsByRequiredFlag - Sort method arguments to place required parameters before optional parameters. (Default: true) - - ensureUniqueParams - Whether to ensure parameter names are unique in an operation (rename parameters that are not). (Default: true) - - allowUnicodeIdentifiers - boolean, toggles whether unicode identifiers are allowed in names or not, default is false (Default: false) - - prependFormOrBodyParameters - Add form or body parameters to the beginning of the parameter list. (Default: false) - - modelPackage - package for generated models - - apiPackage - package for generated api classes - - invokerPackage - root package for generated code - - groupId - groupId in generated pom.xml - - artifactId - artifactId in generated pom.xml - - artifactVersion - artifact version in generated pom.xml - - artifactUrl - artifact URL in generated pom.xml - - artifactDescription - artifact description in generated pom.xml - - scmConnection - SCM connection in generated pom.xml - - scmDeveloperConnection - SCM developer connection in generated pom.xml - - scmUrl - SCM URL in generated pom.xml - - developerName - developer name in generated pom.xml - - developerEmail - developer email in generated pom.xml - - developerOrganization - developer organization in generated pom.xml - - developerOrganizationUrl - developer organization URL in generated pom.xml - - licenseName - The name of the license - - licenseUrl - The URL of the license - - sourceFolder - source folder for generated code - - localVariablePrefix - prefix for generated code members and local variables - - serializableModel - boolean - toggle "implements Serializable" for generated models (Default: false) - - bigDecimalAsString - Treat BigDecimal values as Strings to avoid precision loss. (Default: false) - - fullJavaUtil - whether to use fully qualified name for classes under java.util. This option only works for Java API client (Default: false) - - hideGenerationTimestamp - hides the timestamp when files were generated - - withXml - whether to include support for application/xml content type and include XML annotations in the model (works with libraries that provide support for JSON and XML) (Default: false) - - dateLibrary - Option. Date library to use - joda - Joda (for legacy app only) - legacy - Legacy java.util.Date (if you really have a good reason not to use threetenbp - java8-localdatetime - Java 8 using LocalDateTime (for legacy app only) - java8 - Java 8 native JSR310 (preferred for jdk 1.8+) - note: this also sets "java8" to true - threetenbp - Backport of JSR310 (preferred for jdk < 1.8) - - java8 - Option. Use Java8 classes instead of third party equivalents - true - Use Java 8 classes such as Base64 - false - Various third party libraries as needed - - disableHtmlEscaping - Disable HTML escaping of JSON strings when using gson (needed to avoid problems with byte[] fields) (Default: false) - - booleanGetterPrefix - Set booleanGetterPrefix (default value 'get') - - parentGroupId - parent groupId in generated pom N.B. parentGroupId, parentArtifactId and parentVersion must all be specified for any of them to take effect - - parentArtifactId - parent artifactId in generated pom N.B. parentGroupId, parentArtifactId and parentVersion must all be specified for any of them to take effect - - parentVersion - parent version in generated pom N.B. parentGroupId, parentArtifactId and parentVersion must all be specified for any of them to take effect - - implFolder - folder for generated implementation code - - title - a title describing the application - - useBeanValidation - Use BeanValidation API annotations (Default: true) - - serverPort - The port on which the server should be started - - generateSpringApplication - Generate Spring application (Default: false) - - useSpringAnnotationConfig - Use Spring Annotation Config (Default: false) - - useSwaggerFeature - Use Swagger Feature (Default: false) - - useSwaggerUI - Use Swagger UI (Default: false) - - useWadlFeature - Use WADL Feature (Default: false) - - useMultipartFeature - Use Multipart Feature (Default: false) - - useGzipFeature - Use Gzip Feature (Default: false) - - useGzipFeatureForTests - Use Gzip Feature for tests (Default: false) - - useBeanValidationFeature - Use BeanValidation Feature (Default: false) - - useLoggingFeature - Use Logging Feature (Default: false) - - useLoggingFeatureForTests - Use Logging Feature for tests (Default: false) - - generateSpringBootApplication - Generate Spring Boot application (Default: false) - - generateJbossDeploymentDescriptor - Generate Jboss Deployment Descriptor (Default: false) - - addConsumesProducesJson - Add @Consumes/@Produces Json to API interface (Default: false) - - useAnnotatedBasePath - Use @Path annotations for basePath (Default: false) - - generateNonSpringApplication - Generate non-Spring application (Default: false) - - useGenericResponse - Use generic response (Default: false) - -Back to the [generators list](README.md) +--- +id: generator-opts-server-jaxrs-cxf +title: Config Options for jaxrs-cxf +sidebar_label: jaxrs-cxf +--- + +| Option | Description | Values | Default | +| ------ | ----------- | ------ | ------- | +|sortParamsByRequiredFlag|Sort method arguments 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| +|prependFormOrBodyParameters|Add form or body parameters to the beginning of the parameter list.| |false| +|modelPackage|package for generated models| |null| +|apiPackage|package for generated api classes| |null| +|invokerPackage|root package for generated code| |null| +|groupId|groupId in generated pom.xml| |null| +|artifactId|artifactId in generated pom.xml| |null| +|artifactVersion|artifact version in generated pom.xml| |null| +|artifactUrl|artifact URL in generated pom.xml| |null| +|artifactDescription|artifact description in generated pom.xml| |null| +|scmConnection|SCM connection in generated pom.xml| |null| +|scmDeveloperConnection|SCM developer connection in generated pom.xml| |null| +|scmUrl|SCM URL in generated pom.xml| |null| +|developerName|developer name in generated pom.xml| |null| +|developerEmail|developer email in generated pom.xml| |null| +|developerOrganization|developer organization in generated pom.xml| |null| +|developerOrganizationUrl|developer organization URL in generated pom.xml| |null| +|licenseName|The name of the license| |null| +|licenseUrl|The URL of the license| |null| +|sourceFolder|source folder for generated code| |null| +|localVariablePrefix|prefix for generated code members and local variables| |null| +|serializableModel|boolean - toggle "implements Serializable" for generated models| |false| +|bigDecimalAsString|Treat BigDecimal values as Strings to avoid precision loss.| |false| +|fullJavaUtil|whether to use fully qualified name for classes under java.util. This option only works for Java API client| |false| +|hideGenerationTimestamp|hides the timestamp when files were generated| |null| +|withXml|whether to include support for application/xml content type and include XML annotations in the model (works with libraries that provide support for JSON and XML)| |false| +|dateLibrary|Option. Date library to use|
**joda**
Joda (for legacy app only)
**legacy**
Legacy java.util.Date (if you really have a good reason not to use threetenbp
**java8-localdatetime**
Java 8 using LocalDateTime (for legacy app only)
**java8**
Java 8 native JSR310 (preferred for jdk 1.8+) - note: this also sets "java8" to true
**threetenbp**
Backport of JSR310 (preferred for jdk < 1.8)
|null| +|java8|Option. Use Java8 classes instead of third party equivalents|
**true**
Use Java 8 classes such as Base64
**false**
Various third party libraries as needed
|null| +|disableHtmlEscaping|Disable HTML escaping of JSON strings when using gson (needed to avoid problems with byte[] fields)| |false| +|booleanGetterPrefix|Set booleanGetterPrefix (default value 'get')| |null| +|parentGroupId|parent groupId in generated pom N.B. parentGroupId, parentArtifactId and parentVersion must all be specified for any of them to take effect| |null| +|parentArtifactId|parent artifactId in generated pom N.B. parentGroupId, parentArtifactId and parentVersion must all be specified for any of them to take effect| |null| +|parentVersion|parent version in generated pom N.B. parentGroupId, parentArtifactId and parentVersion must all be specified for any of them to take effect| |null| +|implFolder|folder for generated implementation code| |null| +|title|a title describing the application| |null| +|useBeanValidation|Use BeanValidation API annotations| |true| +|serverPort|The port on which the server should be started| |null| +|generateSpringApplication|Generate Spring application| |false| +|useSpringAnnotationConfig|Use Spring Annotation Config| |false| +|useSwaggerFeature|Use Swagger Feature| |false| +|useSwaggerUI|Use Swagger UI| |false| +|useWadlFeature|Use WADL Feature| |false| +|useMultipartFeature|Use Multipart Feature| |false| +|useGzipFeature|Use Gzip Feature| |false| +|useGzipFeatureForTests|Use Gzip Feature for tests| |false| +|useBeanValidationFeature|Use BeanValidation Feature| |false| +|useLoggingFeature|Use Logging Feature| |false| +|useLoggingFeatureForTests|Use Logging Feature for tests| |false| +|generateSpringBootApplication|Generate Spring Boot application| |false| +|generateJbossDeploymentDescriptor|Generate Jboss Deployment Descriptor| |false| +|addConsumesProducesJson|Add @Consumes/@Produces Json to API interface| |false| +|useAnnotatedBasePath|Use @Path annotations for basePath| |false| +|generateNonSpringApplication|Generate non-Spring application| |false| +|useGenericResponse|Use generic response| |false| diff --git a/docs/generators/jaxrs-jersey.md b/docs/generators/jaxrs-jersey.md index b4b0d29c76f4..b9a44df0ecc9 100644 --- a/docs/generators/jaxrs-jersey.md +++ b/docs/generators/jaxrs-jersey.md @@ -1,139 +1,51 @@ -CONFIG OPTIONS for jaxrs-jersey - - sortParamsByRequiredFlag - Sort method arguments to place required parameters before optional parameters. (Default: true) - - ensureUniqueParams - Whether to ensure parameter names are unique in an operation (rename parameters that are not). (Default: true) - - allowUnicodeIdentifiers - boolean, toggles whether unicode identifiers are allowed in names or not, default is false (Default: false) - - prependFormOrBodyParameters - Add form or body parameters to the beginning of the parameter list. (Default: false) - - modelPackage - package for generated models - - apiPackage - package for generated api classes - - invokerPackage - root package for generated code - - groupId - groupId in generated pom.xml - - artifactId - artifactId in generated pom.xml - - artifactVersion - artifact version in generated pom.xml - - artifactUrl - artifact URL in generated pom.xml - - artifactDescription - artifact description in generated pom.xml - - scmConnection - SCM connection in generated pom.xml - - scmDeveloperConnection - SCM developer connection in generated pom.xml - - scmUrl - SCM URL in generated pom.xml - - developerName - developer name in generated pom.xml - - developerEmail - developer email in generated pom.xml - - developerOrganization - developer organization in generated pom.xml - - developerOrganizationUrl - developer organization URL in generated pom.xml - - licenseName - The name of the license - - licenseUrl - The URL of the license - - sourceFolder - source folder for generated code - - localVariablePrefix - prefix for generated code members and local variables - - serializableModel - boolean - toggle "implements Serializable" for generated models (Default: false) - - bigDecimalAsString - Treat BigDecimal values as Strings to avoid precision loss. (Default: false) - - fullJavaUtil - whether to use fully qualified name for classes under java.util. This option only works for Java API client (Default: false) - - hideGenerationTimestamp - hides the timestamp when files were generated - - withXml - whether to include support for application/xml content type and include XML annotations in the model (works with libraries that provide support for JSON and XML) (Default: false) - - dateLibrary - Option. Date library to use - joda - Joda (for legacy app only) - legacy - Legacy java.util.Date (if you really have a good reason not to use threetenbp - java8-localdatetime - Java 8 using LocalDateTime (for legacy app only) - java8 - Java 8 native JSR310 (preferred for jdk 1.8+) - note: this also sets "java8" to true - threetenbp - Backport of JSR310 (preferred for jdk < 1.8) - - java8 - Option. Use Java8 classes instead of third party equivalents - true - Use Java 8 classes such as Base64 - false - Various third party libraries as needed - - disableHtmlEscaping - Disable HTML escaping of JSON strings when using gson (needed to avoid problems with byte[] fields) (Default: false) - - booleanGetterPrefix - Set booleanGetterPrefix (default value 'get') - - parentGroupId - parent groupId in generated pom N.B. parentGroupId, parentArtifactId and parentVersion must all be specified for any of them to take effect - - parentArtifactId - parent artifactId in generated pom N.B. parentGroupId, parentArtifactId and parentVersion must all be specified for any of them to take effect - - parentVersion - parent version in generated pom N.B. parentGroupId, parentArtifactId and parentVersion must all be specified for any of them to take effect - - implFolder - folder for generated implementation code - - title - a title describing the application - - useBeanValidation - Use BeanValidation API annotations (Default: true) - - serverPort - The port on which the server should be started - - library - library template (sub-template) to use (Default: jersey2) - jersey1 - Jersey core 1.x - jersey2 - Jersey core 2.x - - supportJava6 - Whether to support Java6 with the Jersey1/2 library. (Default: false) - - useTags - use tags for creating interface and controller classnames (Default: false) - -Back to the [generators list](README.md) +--- +id: generator-opts-server-jaxrs-jersey +title: Config Options for jaxrs-jersey +sidebar_label: jaxrs-jersey +--- + +| Option | Description | Values | Default | +| ------ | ----------- | ------ | ------- | +|sortParamsByRequiredFlag|Sort method arguments 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| +|prependFormOrBodyParameters|Add form or body parameters to the beginning of the parameter list.| |false| +|modelPackage|package for generated models| |null| +|apiPackage|package for generated api classes| |null| +|invokerPackage|root package for generated code| |null| +|groupId|groupId in generated pom.xml| |null| +|artifactId|artifactId in generated pom.xml| |null| +|artifactVersion|artifact version in generated pom.xml| |null| +|artifactUrl|artifact URL in generated pom.xml| |null| +|artifactDescription|artifact description in generated pom.xml| |null| +|scmConnection|SCM connection in generated pom.xml| |null| +|scmDeveloperConnection|SCM developer connection in generated pom.xml| |null| +|scmUrl|SCM URL in generated pom.xml| |null| +|developerName|developer name in generated pom.xml| |null| +|developerEmail|developer email in generated pom.xml| |null| +|developerOrganization|developer organization in generated pom.xml| |null| +|developerOrganizationUrl|developer organization URL in generated pom.xml| |null| +|licenseName|The name of the license| |null| +|licenseUrl|The URL of the license| |null| +|sourceFolder|source folder for generated code| |null| +|localVariablePrefix|prefix for generated code members and local variables| |null| +|serializableModel|boolean - toggle "implements Serializable" for generated models| |false| +|bigDecimalAsString|Treat BigDecimal values as Strings to avoid precision loss.| |false| +|fullJavaUtil|whether to use fully qualified name for classes under java.util. This option only works for Java API client| |false| +|hideGenerationTimestamp|hides the timestamp when files were generated| |null| +|withXml|whether to include support for application/xml content type and include XML annotations in the model (works with libraries that provide support for JSON and XML)| |false| +|dateLibrary|Option. Date library to use|
**joda**
Joda (for legacy app only)
**legacy**
Legacy java.util.Date (if you really have a good reason not to use threetenbp
**java8-localdatetime**
Java 8 using LocalDateTime (for legacy app only)
**java8**
Java 8 native JSR310 (preferred for jdk 1.8+) - note: this also sets "java8" to true
**threetenbp**
Backport of JSR310 (preferred for jdk < 1.8)
|null| +|java8|Option. Use Java8 classes instead of third party equivalents|
**true**
Use Java 8 classes such as Base64
**false**
Various third party libraries as needed
|null| +|disableHtmlEscaping|Disable HTML escaping of JSON strings when using gson (needed to avoid problems with byte[] fields)| |false| +|booleanGetterPrefix|Set booleanGetterPrefix (default value 'get')| |null| +|parentGroupId|parent groupId in generated pom N.B. parentGroupId, parentArtifactId and parentVersion must all be specified for any of them to take effect| |null| +|parentArtifactId|parent artifactId in generated pom N.B. parentGroupId, parentArtifactId and parentVersion must all be specified for any of them to take effect| |null| +|parentVersion|parent version in generated pom N.B. parentGroupId, parentArtifactId and parentVersion must all be specified for any of them to take effect| |null| +|implFolder|folder for generated implementation code| |null| +|title|a title describing the application| |null| +|useBeanValidation|Use BeanValidation API annotations| |true| +|serverPort|The port on which the server should be started| |null| +|library|library template (sub-template) to use|
**jersey1**
Jersey core 1.x
**jersey2**
Jersey core 2.x
|jersey2| +|supportJava6|Whether to support Java6 with the Jersey1/2 library.| |false| +|useTags|use tags for creating interface and controller classnames| |false| diff --git a/docs/generators/jaxrs-resteasy-eap.md b/docs/generators/jaxrs-resteasy-eap.md index d031162a1fc7..03275a94975e 100644 --- a/docs/generators/jaxrs-resteasy-eap.md +++ b/docs/generators/jaxrs-resteasy-eap.md @@ -1,137 +1,51 @@ -CONFIG OPTIONS for jaxrs-resteasy-eap - - sortParamsByRequiredFlag - Sort method arguments to place required parameters before optional parameters. (Default: true) - - ensureUniqueParams - Whether to ensure parameter names are unique in an operation (rename parameters that are not). (Default: true) - - allowUnicodeIdentifiers - boolean, toggles whether unicode identifiers are allowed in names or not, default is false (Default: false) - - prependFormOrBodyParameters - Add form or body parameters to the beginning of the parameter list. (Default: false) - - modelPackage - package for generated models - - apiPackage - package for generated api classes - - invokerPackage - root package for generated code - - groupId - groupId in generated pom.xml - - artifactId - artifactId in generated pom.xml - - artifactVersion - artifact version in generated pom.xml - - artifactUrl - artifact URL in generated pom.xml - - artifactDescription - artifact description in generated pom.xml - - scmConnection - SCM connection in generated pom.xml - - scmDeveloperConnection - SCM developer connection in generated pom.xml - - scmUrl - SCM URL in generated pom.xml - - developerName - developer name in generated pom.xml - - developerEmail - developer email in generated pom.xml - - developerOrganization - developer organization in generated pom.xml - - developerOrganizationUrl - developer organization URL in generated pom.xml - - licenseName - The name of the license - - licenseUrl - The URL of the license - - sourceFolder - source folder for generated code - - localVariablePrefix - prefix for generated code members and local variables - - serializableModel - boolean - toggle "implements Serializable" for generated models (Default: false) - - bigDecimalAsString - Treat BigDecimal values as Strings to avoid precision loss. (Default: false) - - fullJavaUtil - whether to use fully qualified name for classes under java.util. This option only works for Java API client (Default: false) - - hideGenerationTimestamp - hides the timestamp when files were generated - - withXml - whether to include support for application/xml content type and include XML annotations in the model (works with libraries that provide support for JSON and XML) (Default: false) - - dateLibrary - Option. Date library to use - joda - Joda (for legacy app only) - legacy - Legacy java.util.Date (if you really have a good reason not to use threetenbp - java8-localdatetime - Java 8 using LocalDateTime (for legacy app only) - java8 - Java 8 native JSR310 (preferred for jdk 1.8+) - note: this also sets "java8" to true - threetenbp - Backport of JSR310 (preferred for jdk < 1.8) - - java8 - Option. Use Java8 classes instead of third party equivalents - true - Use Java 8 classes such as Base64 - false - Various third party libraries as needed - - disableHtmlEscaping - Disable HTML escaping of JSON strings when using gson (needed to avoid problems with byte[] fields) (Default: false) - - booleanGetterPrefix - Set booleanGetterPrefix (default value 'get') - - parentGroupId - parent groupId in generated pom N.B. parentGroupId, parentArtifactId and parentVersion must all be specified for any of them to take effect - - parentArtifactId - parent artifactId in generated pom N.B. parentGroupId, parentArtifactId and parentVersion must all be specified for any of them to take effect - - parentVersion - parent version in generated pom N.B. parentGroupId, parentArtifactId and parentVersion must all be specified for any of them to take effect - - implFolder - folder for generated implementation code - - title - a title describing the application - - useBeanValidation - Use BeanValidation API annotations (Default: true) - - serverPort - The port on which the server should be started - - useBeanValidation - Use BeanValidation API annotations (Default: true) - - generateJbossDeploymentDescriptor - Generate Jboss Deployment Descriptor (Default: true) - - useSwaggerFeature - Use dynamic Swagger generator (Default: false) - -Back to the [generators list](README.md) +--- +id: generator-opts-server-jaxrs-resteasy-eap +title: Config Options for jaxrs-resteasy-eap +sidebar_label: jaxrs-resteasy-eap +--- + +| Option | Description | Values | Default | +| ------ | ----------- | ------ | ------- | +|sortParamsByRequiredFlag|Sort method arguments 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| +|prependFormOrBodyParameters|Add form or body parameters to the beginning of the parameter list.| |false| +|modelPackage|package for generated models| |null| +|apiPackage|package for generated api classes| |null| +|invokerPackage|root package for generated code| |null| +|groupId|groupId in generated pom.xml| |null| +|artifactId|artifactId in generated pom.xml| |null| +|artifactVersion|artifact version in generated pom.xml| |null| +|artifactUrl|artifact URL in generated pom.xml| |null| +|artifactDescription|artifact description in generated pom.xml| |null| +|scmConnection|SCM connection in generated pom.xml| |null| +|scmDeveloperConnection|SCM developer connection in generated pom.xml| |null| +|scmUrl|SCM URL in generated pom.xml| |null| +|developerName|developer name in generated pom.xml| |null| +|developerEmail|developer email in generated pom.xml| |null| +|developerOrganization|developer organization in generated pom.xml| |null| +|developerOrganizationUrl|developer organization URL in generated pom.xml| |null| +|licenseName|The name of the license| |null| +|licenseUrl|The URL of the license| |null| +|sourceFolder|source folder for generated code| |null| +|localVariablePrefix|prefix for generated code members and local variables| |null| +|serializableModel|boolean - toggle "implements Serializable" for generated models| |false| +|bigDecimalAsString|Treat BigDecimal values as Strings to avoid precision loss.| |false| +|fullJavaUtil|whether to use fully qualified name for classes under java.util. This option only works for Java API client| |false| +|hideGenerationTimestamp|hides the timestamp when files were generated| |null| +|withXml|whether to include support for application/xml content type and include XML annotations in the model (works with libraries that provide support for JSON and XML)| |false| +|dateLibrary|Option. Date library to use|
**joda**
Joda (for legacy app only)
**legacy**
Legacy java.util.Date (if you really have a good reason not to use threetenbp
**java8-localdatetime**
Java 8 using LocalDateTime (for legacy app only)
**java8**
Java 8 native JSR310 (preferred for jdk 1.8+) - note: this also sets "java8" to true
**threetenbp**
Backport of JSR310 (preferred for jdk < 1.8)
|null| +|java8|Option. Use Java8 classes instead of third party equivalents|
**true**
Use Java 8 classes such as Base64
**false**
Various third party libraries as needed
|null| +|disableHtmlEscaping|Disable HTML escaping of JSON strings when using gson (needed to avoid problems with byte[] fields)| |false| +|booleanGetterPrefix|Set booleanGetterPrefix (default value 'get')| |null| +|parentGroupId|parent groupId in generated pom N.B. parentGroupId, parentArtifactId and parentVersion must all be specified for any of them to take effect| |null| +|parentArtifactId|parent artifactId in generated pom N.B. parentGroupId, parentArtifactId and parentVersion must all be specified for any of them to take effect| |null| +|parentVersion|parent version in generated pom N.B. parentGroupId, parentArtifactId and parentVersion must all be specified for any of them to take effect| |null| +|implFolder|folder for generated implementation code| |null| +|title|a title describing the application| |null| +|useBeanValidation|Use BeanValidation API annotations| |true| +|serverPort|The port on which the server should be started| |null| +|useBeanValidation|Use BeanValidation API annotations| |true| +|generateJbossDeploymentDescriptor|Generate Jboss Deployment Descriptor| |true| +|useSwaggerFeature|Use dynamic Swagger generator| |false| diff --git a/docs/generators/jaxrs-resteasy.md b/docs/generators/jaxrs-resteasy.md index 56db591b479a..ae148d03a22e 100644 --- a/docs/generators/jaxrs-resteasy.md +++ b/docs/generators/jaxrs-resteasy.md @@ -1,131 +1,49 @@ -CONFIG OPTIONS for jaxrs-resteasy - - sortParamsByRequiredFlag - Sort method arguments to place required parameters before optional parameters. (Default: true) - - ensureUniqueParams - Whether to ensure parameter names are unique in an operation (rename parameters that are not). (Default: true) - - allowUnicodeIdentifiers - boolean, toggles whether unicode identifiers are allowed in names or not, default is false (Default: false) - - prependFormOrBodyParameters - Add form or body parameters to the beginning of the parameter list. (Default: false) - - modelPackage - package for generated models - - apiPackage - package for generated api classes - - invokerPackage - root package for generated code - - groupId - groupId in generated pom.xml - - artifactId - artifactId in generated pom.xml - - artifactVersion - artifact version in generated pom.xml - - artifactUrl - artifact URL in generated pom.xml - - artifactDescription - artifact description in generated pom.xml - - scmConnection - SCM connection in generated pom.xml - - scmDeveloperConnection - SCM developer connection in generated pom.xml - - scmUrl - SCM URL in generated pom.xml - - developerName - developer name in generated pom.xml - - developerEmail - developer email in generated pom.xml - - developerOrganization - developer organization in generated pom.xml - - developerOrganizationUrl - developer organization URL in generated pom.xml - - licenseName - The name of the license - - licenseUrl - The URL of the license - - sourceFolder - source folder for generated code - - localVariablePrefix - prefix for generated code members and local variables - - serializableModel - boolean - toggle "implements Serializable" for generated models (Default: false) - - bigDecimalAsString - Treat BigDecimal values as Strings to avoid precision loss. (Default: false) - - fullJavaUtil - whether to use fully qualified name for classes under java.util. This option only works for Java API client (Default: false) - - hideGenerationTimestamp - hides the timestamp when files were generated - - withXml - whether to include support for application/xml content type and include XML annotations in the model (works with libraries that provide support for JSON and XML) (Default: false) - - dateLibrary - Option. Date library to use - joda - Joda (for legacy app only) - legacy - Legacy java.util.Date (if you really have a good reason not to use threetenbp - java8-localdatetime - Java 8 using LocalDateTime (for legacy app only) - java8 - Java 8 native JSR310 (preferred for jdk 1.8+) - note: this also sets "java8" to true - threetenbp - Backport of JSR310 (preferred for jdk < 1.8) - - java8 - Option. Use Java8 classes instead of third party equivalents - true - Use Java 8 classes such as Base64 - false - Various third party libraries as needed - - disableHtmlEscaping - Disable HTML escaping of JSON strings when using gson (needed to avoid problems with byte[] fields) (Default: false) - - booleanGetterPrefix - Set booleanGetterPrefix (default value 'get') - - parentGroupId - parent groupId in generated pom N.B. parentGroupId, parentArtifactId and parentVersion must all be specified for any of them to take effect - - parentArtifactId - parent artifactId in generated pom N.B. parentGroupId, parentArtifactId and parentVersion must all be specified for any of them to take effect - - parentVersion - parent version in generated pom N.B. parentGroupId, parentArtifactId and parentVersion must all be specified for any of them to take effect - - implFolder - folder for generated implementation code - - title - a title describing the application - - useBeanValidation - Use BeanValidation API annotations (Default: true) - - serverPort - The port on which the server should be started - - generateJbossDeploymentDescriptor - Generate Jboss Deployment Descriptor (Default: false) - -Back to the [generators list](README.md) +--- +id: generator-opts-server-jaxrs-resteasy +title: Config Options for jaxrs-resteasy +sidebar_label: jaxrs-resteasy +--- + +| Option | Description | Values | Default | +| ------ | ----------- | ------ | ------- | +|sortParamsByRequiredFlag|Sort method arguments 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| +|prependFormOrBodyParameters|Add form or body parameters to the beginning of the parameter list.| |false| +|modelPackage|package for generated models| |null| +|apiPackage|package for generated api classes| |null| +|invokerPackage|root package for generated code| |null| +|groupId|groupId in generated pom.xml| |null| +|artifactId|artifactId in generated pom.xml| |null| +|artifactVersion|artifact version in generated pom.xml| |null| +|artifactUrl|artifact URL in generated pom.xml| |null| +|artifactDescription|artifact description in generated pom.xml| |null| +|scmConnection|SCM connection in generated pom.xml| |null| +|scmDeveloperConnection|SCM developer connection in generated pom.xml| |null| +|scmUrl|SCM URL in generated pom.xml| |null| +|developerName|developer name in generated pom.xml| |null| +|developerEmail|developer email in generated pom.xml| |null| +|developerOrganization|developer organization in generated pom.xml| |null| +|developerOrganizationUrl|developer organization URL in generated pom.xml| |null| +|licenseName|The name of the license| |null| +|licenseUrl|The URL of the license| |null| +|sourceFolder|source folder for generated code| |null| +|localVariablePrefix|prefix for generated code members and local variables| |null| +|serializableModel|boolean - toggle "implements Serializable" for generated models| |false| +|bigDecimalAsString|Treat BigDecimal values as Strings to avoid precision loss.| |false| +|fullJavaUtil|whether to use fully qualified name for classes under java.util. This option only works for Java API client| |false| +|hideGenerationTimestamp|hides the timestamp when files were generated| |null| +|withXml|whether to include support for application/xml content type and include XML annotations in the model (works with libraries that provide support for JSON and XML)| |false| +|dateLibrary|Option. Date library to use|
**joda**
Joda (for legacy app only)
**legacy**
Legacy java.util.Date (if you really have a good reason not to use threetenbp
**java8-localdatetime**
Java 8 using LocalDateTime (for legacy app only)
**java8**
Java 8 native JSR310 (preferred for jdk 1.8+) - note: this also sets "java8" to true
**threetenbp**
Backport of JSR310 (preferred for jdk < 1.8)
|null| +|java8|Option. Use Java8 classes instead of third party equivalents|
**true**
Use Java 8 classes such as Base64
**false**
Various third party libraries as needed
|null| +|disableHtmlEscaping|Disable HTML escaping of JSON strings when using gson (needed to avoid problems with byte[] fields)| |false| +|booleanGetterPrefix|Set booleanGetterPrefix (default value 'get')| |null| +|parentGroupId|parent groupId in generated pom N.B. parentGroupId, parentArtifactId and parentVersion must all be specified for any of them to take effect| |null| +|parentArtifactId|parent artifactId in generated pom N.B. parentGroupId, parentArtifactId and parentVersion must all be specified for any of them to take effect| |null| +|parentVersion|parent version in generated pom N.B. parentGroupId, parentArtifactId and parentVersion must all be specified for any of them to take effect| |null| +|implFolder|folder for generated implementation code| |null| +|title|a title describing the application| |null| +|useBeanValidation|Use BeanValidation API annotations| |true| +|serverPort|The port on which the server should be started| |null| +|generateJbossDeploymentDescriptor|Generate Jboss Deployment Descriptor| |false| diff --git a/docs/generators/jaxrs-spec.md b/docs/generators/jaxrs-spec.md index 1c9a9cf12d31..e421039fc8e0 100644 --- a/docs/generators/jaxrs-spec.md +++ b/docs/generators/jaxrs-spec.md @@ -1,144 +1,53 @@ -CONFIG OPTIONS for jaxrs-spec - - sortParamsByRequiredFlag - Sort method arguments to place required parameters before optional parameters. (Default: true) - - ensureUniqueParams - Whether to ensure parameter names are unique in an operation (rename parameters that are not). (Default: true) - - allowUnicodeIdentifiers - boolean, toggles whether unicode identifiers are allowed in names or not, default is false (Default: false) - - prependFormOrBodyParameters - Add form or body parameters to the beginning of the parameter list. (Default: false) - - modelPackage - package for generated models - - apiPackage - package for generated api classes - - invokerPackage - root package for generated code - - groupId - groupId in generated pom.xml - - artifactId - artifactId in generated pom.xml - - artifactVersion - artifact version in generated pom.xml - - artifactUrl - artifact URL in generated pom.xml - - artifactDescription - artifact description in generated pom.xml - - scmConnection - SCM connection in generated pom.xml - - scmDeveloperConnection - SCM developer connection in generated pom.xml - - scmUrl - SCM URL in generated pom.xml - - developerName - developer name in generated pom.xml - - developerEmail - developer email in generated pom.xml - - developerOrganization - developer organization in generated pom.xml - - developerOrganizationUrl - developer organization URL in generated pom.xml - - licenseName - The name of the license - - licenseUrl - The URL of the license - - sourceFolder - source folder for generated code - - localVariablePrefix - prefix for generated code members and local variables - - serializableModel - boolean - toggle "implements Serializable" for generated models (Default: false) - - bigDecimalAsString - Treat BigDecimal values as Strings to avoid precision loss. (Default: false) - - fullJavaUtil - whether to use fully qualified name for classes under java.util. This option only works for Java API client (Default: false) - - hideGenerationTimestamp - hides the timestamp when files were generated - - withXml - whether to include support for application/xml content type and include XML annotations in the model (works with libraries that provide support for JSON and XML) (Default: false) - - dateLibrary - Option. Date library to use - joda - Joda (for legacy app only) - legacy - Legacy java.util.Date (if you really have a good reason not to use threetenbp - java8-localdatetime - Java 8 using LocalDateTime (for legacy app only) - java8 - Java 8 native JSR310 (preferred for jdk 1.8+) - note: this also sets "java8" to true - threetenbp - Backport of JSR310 (preferred for jdk < 1.8) - - java8 - Option. Use Java8 classes instead of third party equivalents - true - Use Java 8 classes such as Base64 - false - Various third party libraries as needed - - disableHtmlEscaping - Disable HTML escaping of JSON strings when using gson (needed to avoid problems with byte[] fields) (Default: false) - - booleanGetterPrefix - Set booleanGetterPrefix (default value 'get') - - parentGroupId - parent groupId in generated pom N.B. parentGroupId, parentArtifactId and parentVersion must all be specified for any of them to take effect - - parentArtifactId - parent artifactId in generated pom N.B. parentGroupId, parentArtifactId and parentVersion must all be specified for any of them to take effect - - parentVersion - parent version in generated pom N.B. parentGroupId, parentArtifactId and parentVersion must all be specified for any of them to take effect - - implFolder - folder for generated implementation code - - title - a title describing the application - - useBeanValidation - Use BeanValidation API annotations (Default: true) - - serverPort - The port on which the server should be started - - library - library template (sub-template) to use (Default: ) - - JAXRS - - generatePom - Whether to generate pom.xml if the file does not already exist. (Default: true) - - interfaceOnly - Whether to generate only API interface stubs without the server files. (Default: false) - - returnResponse - Whether generate API interface should return javax.ws.rs.core.Response instead of a deserialized entity. Only useful if interfaceOnly is true. (Default: false) - - useSwaggerAnnotations - Whether to generate Swagger annotations. (Default: true) - -Back to the [generators list](README.md) +--- +id: generator-opts-server-jaxrs-spec +title: Config Options for jaxrs-spec +sidebar_label: jaxrs-spec +--- + +| Option | Description | Values | Default | +| ------ | ----------- | ------ | ------- | +|sortParamsByRequiredFlag|Sort method arguments 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| +|prependFormOrBodyParameters|Add form or body parameters to the beginning of the parameter list.| |false| +|modelPackage|package for generated models| |null| +|apiPackage|package for generated api classes| |null| +|invokerPackage|root package for generated code| |null| +|groupId|groupId in generated pom.xml| |null| +|artifactId|artifactId in generated pom.xml| |null| +|artifactVersion|artifact version in generated pom.xml| |null| +|artifactUrl|artifact URL in generated pom.xml| |null| +|artifactDescription|artifact description in generated pom.xml| |null| +|scmConnection|SCM connection in generated pom.xml| |null| +|scmDeveloperConnection|SCM developer connection in generated pom.xml| |null| +|scmUrl|SCM URL in generated pom.xml| |null| +|developerName|developer name in generated pom.xml| |null| +|developerEmail|developer email in generated pom.xml| |null| +|developerOrganization|developer organization in generated pom.xml| |null| +|developerOrganizationUrl|developer organization URL in generated pom.xml| |null| +|licenseName|The name of the license| |null| +|licenseUrl|The URL of the license| |null| +|sourceFolder|source folder for generated code| |null| +|localVariablePrefix|prefix for generated code members and local variables| |null| +|serializableModel|boolean - toggle "implements Serializable" for generated models| |false| +|bigDecimalAsString|Treat BigDecimal values as Strings to avoid precision loss.| |false| +|fullJavaUtil|whether to use fully qualified name for classes under java.util. This option only works for Java API client| |false| +|hideGenerationTimestamp|hides the timestamp when files were generated| |null| +|withXml|whether to include support for application/xml content type and include XML annotations in the model (works with libraries that provide support for JSON and XML)| |false| +|dateLibrary|Option. Date library to use|
**joda**
Joda (for legacy app only)
**legacy**
Legacy java.util.Date (if you really have a good reason not to use threetenbp
**java8-localdatetime**
Java 8 using LocalDateTime (for legacy app only)
**java8**
Java 8 native JSR310 (preferred for jdk 1.8+) - note: this also sets "java8" to true
**threetenbp**
Backport of JSR310 (preferred for jdk < 1.8)
|null| +|java8|Option. Use Java8 classes instead of third party equivalents|
**true**
Use Java 8 classes such as Base64
**false**
Various third party libraries as needed
|null| +|disableHtmlEscaping|Disable HTML escaping of JSON strings when using gson (needed to avoid problems with byte[] fields)| |false| +|booleanGetterPrefix|Set booleanGetterPrefix (default value 'get')| |null| +|parentGroupId|parent groupId in generated pom N.B. parentGroupId, parentArtifactId and parentVersion must all be specified for any of them to take effect| |null| +|parentArtifactId|parent artifactId in generated pom N.B. parentGroupId, parentArtifactId and parentVersion must all be specified for any of them to take effect| |null| +|parentVersion|parent version in generated pom N.B. parentGroupId, parentArtifactId and parentVersion must all be specified for any of them to take effect| |null| +|implFolder|folder for generated implementation code| |null| +|title|a title describing the application| |null| +|useBeanValidation|Use BeanValidation API annotations| |true| +|serverPort|The port on which the server should be started| |null| +|library|library template (sub-template) to use|
**<default>**
JAXRS
|<default>| +|generatePom|Whether to generate pom.xml if the file does not already exist.| |true| +|interfaceOnly|Whether to generate only API interface stubs without the server files.| |false| +|returnResponse|Whether generate API interface should return javax.ws.rs.core.Response instead of a deserialized entity. Only useful if interfaceOnly is true.| |false| +|useSwaggerAnnotations|Whether to generate Swagger annotations.| |true| diff --git a/docs/generators/jmeter.md b/docs/generators/jmeter.md index c9a8d2a0e9f4..6771efad160c 100644 --- a/docs/generators/jmeter.md +++ b/docs/generators/jmeter.md @@ -1,16 +1,13 @@ -CONFIG OPTIONS for jmeter - - sortParamsByRequiredFlag - Sort method arguments to place required parameters before optional parameters. (Default: true) - - ensureUniqueParams - Whether to ensure parameter names are unique in an operation (rename parameters that are not). (Default: true) - - allowUnicodeIdentifiers - boolean, toggles whether unicode identifiers are allowed in names or not, default is false (Default: false) - - prependFormOrBodyParameters - Add form or body parameters to the beginning of the parameter list. (Default: false) - -Back to the [generators list](README.md) +--- +id: generator-opts-client-jmeter +title: Config Options for jmeter +sidebar_label: jmeter +--- + +| Option | Description | Values | Default | +| ------ | ----------- | ------ | ------- | +|sortParamsByRequiredFlag|Sort method arguments 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| +|prependFormOrBodyParameters|Add form or body parameters to the beginning of the parameter list.| |false| diff --git a/docs/generators/kotlin-server.md b/docs/generators/kotlin-server.md index 3ff4b6151717..07be315a0dca 100644 --- a/docs/generators/kotlin-server.md +++ b/docs/generators/kotlin-server.md @@ -1,44 +1,22 @@ -CONFIG OPTIONS for kotlin-server - - sourceFolder - source folder for generated code (Default: src/main/kotlin) - - packageName - Generated artifact package name. (Default: org.openapitools) - - groupId - Generated artifact package's organization (i.e. maven groupId). (Default: org.openapitools) - - artifactId - Generated artifact id (name of jar). - - artifactVersion - Generated artifact's package version. (Default: 1.0.0) - - enumPropertyNaming - Naming convention for enum properties: 'camelCase', 'PascalCase', 'snake_case', 'UPPERCASE', and 'original' (Default: camelCase) - - parcelizeModels - toggle "@Parcelize" for generated models - - library - library template (sub-template) to use (Default: ktor) - ktor - ktor framework - - featureAutoHead - Automatically provide responses to HEAD requests for existing routes that have the GET verb defined. (Default: true) - - featureConditionalHeaders - Avoid sending content if client already has same content, by checking ETag or LastModified properties. (Default: false) - - featureHSTS - Avoid sending content if client already has same content, by checking ETag or LastModified properties. (Default: true) - - featureCORS - Ktor by default provides an interceptor for implementing proper support for Cross-Origin Resource Sharing (CORS). See enable-cors.org. (Default: false) - - featureCompression - Adds ability to compress outgoing content using gzip, deflate or custom encoder and thus reduce size of the response. (Default: true) - -Back to the [generators list](README.md) +--- +id: generator-opts-server-kotlin-server +title: Config Options for kotlin-server +sidebar_label: kotlin-server +--- + +| Option | Description | Values | Default | +| ------ | ----------- | ------ | ------- | +|sourceFolder|source folder for generated code| |src/main/kotlin| +|packageName|Generated artifact package name.| |org.openapitools| +|groupId|Generated artifact package's organization (i.e. maven groupId).| |org.openapitools| +|artifactId|Generated artifact id (name of jar).| |null| +|artifactVersion|Generated artifact's package version.| |1.0.0| +|enumPropertyNaming|Naming convention for enum properties: 'camelCase', 'PascalCase', 'snake_case', 'UPPERCASE', and 'original'| |camelCase| +|parcelizeModels|toggle "@Parcelize" for generated models| |null| +|library|library template (sub-template) to use|
**ktor**
ktor framework
|ktor| +|featureAutoHead|Automatically provide responses to HEAD requests for existing routes that have the GET verb defined.| |true| +|featureConditionalHeaders|Avoid sending content if client already has same content, by checking ETag or LastModified properties.| |false| +|featureHSTS|Avoid sending content if client already has same content, by checking ETag or LastModified properties.| |true| +|featureCORS|Ktor by default provides an interceptor for implementing proper support for Cross-Origin Resource Sharing (CORS). See enable-cors.org.| |false| +|featureCompression|Adds ability to compress outgoing content using gzip, deflate or custom encoder and thus reduce size of the response.| |true| diff --git a/docs/generators/kotlin-spring.md b/docs/generators/kotlin-spring.md index 568c3967eec9..89ec5f81e793 100644 --- a/docs/generators/kotlin-spring.md +++ b/docs/generators/kotlin-spring.md @@ -1,62 +1,28 @@ -CONFIG OPTIONS for kotlin-spring - - sourceFolder - source folder for generated code (Default: src/main/kotlin) - - packageName - Generated artifact package name. (Default: org.openapitools) - - groupId - Generated artifact package's organization (i.e. maven groupId). (Default: org.openapitools) - - artifactId - Generated artifact id (name of jar). - - artifactVersion - Generated artifact's package version. (Default: 1.0.0) - - enumPropertyNaming - Naming convention for enum properties: 'camelCase', 'PascalCase', 'snake_case', 'UPPERCASE', and 'original' (Default: camelCase) - - parcelizeModels - toggle "@Parcelize" for generated models - - title - server title name or client service name (Default: OpenAPI Kotlin Spring) - - basePackage - base package (invokerPackage) for generated code (Default: org.openapitools) - - serverPort - configuration the port in which the sever is to run on (Default: 8080) - - modelPackage - model package for generated code (Default: org.openapitools.model) - - apiPackage - api package for generated code (Default: org.openapitools.api) - - exceptionHandler - generate default global exception handlers (Default: true) - - gradleBuildFile - generate a gradle build file using the Kotlin DSL (Default: true) - - swaggerAnnotations - generate swagger annotations to go alongside controllers and models (Default: false) - - serviceInterface - generate service interfaces to go alongside controllers. In most cases this option would be used to update an existing project, so not to override implementations. Useful to help facilitate the generation gap pattern (Default: false) - - serviceImplementation - generate stub service implementations that extends service interfaces. If this is set to true service interfaces will also be generated (Default: false) - - useBeanValidation - Use BeanValidation API annotations to validate data types (Default: true) - - library - library template (sub-template) to use (Default: spring-boot) - spring-boot - Spring-boot Server application. - -Back to the [generators list](README.md) +--- +id: generator-opts-server-kotlin-spring +title: Config Options for kotlin-spring +sidebar_label: kotlin-spring +--- + +| Option | Description | Values | Default | +| ------ | ----------- | ------ | ------- | +|sourceFolder|source folder for generated code| |src/main/kotlin| +|packageName|Generated artifact package name.| |org.openapitools| +|groupId|Generated artifact package's organization (i.e. maven groupId).| |org.openapitools| +|artifactId|Generated artifact id (name of jar).| |null| +|artifactVersion|Generated artifact's package version.| |1.0.0| +|enumPropertyNaming|Naming convention for enum properties: 'camelCase', 'PascalCase', 'snake_case', 'UPPERCASE', and 'original'| |camelCase| +|parcelizeModels|toggle "@Parcelize" for generated models| |null| +|title|server title name or client service name| |OpenAPI Kotlin Spring| +|basePackage|base package (invokerPackage) for generated code| |org.openapitools| +|serverPort|configuration the port in which the sever is to run on| |8080| +|modelPackage|model package for generated code| |org.openapitools.model| +|apiPackage|api package for generated code| |org.openapitools.api| +|exceptionHandler|generate default global exception handlers| |true| +|gradleBuildFile|generate a gradle build file using the Kotlin DSL| |true| +|swaggerAnnotations|generate swagger annotations to go alongside controllers and models| |false| +|serviceInterface|generate service interfaces to go alongside controllers. In most cases this option would be used to update an existing project, so not to override implementations. Useful to help facilitate the generation gap pattern| |false| +|serviceImplementation|generate stub service implementations that extends service interfaces. If this is set to true service interfaces will also be generated| |false| +|useBeanValidation|Use BeanValidation API annotations to validate data types| |true| +|library|library template (sub-template) to use|
**spring-boot**
Spring-boot Server application.
|spring-boot| diff --git a/docs/generators/kotlin.md b/docs/generators/kotlin.md index 0aee9282c642..55ae9f22bce8 100644 --- a/docs/generators/kotlin.md +++ b/docs/generators/kotlin.md @@ -1,36 +1,18 @@ -CONFIG OPTIONS for kotlin - - sourceFolder - source folder for generated code (Default: src/main/kotlin) - - packageName - Generated artifact package name. (Default: org.openapitools) - - groupId - Generated artifact package's organization (i.e. maven groupId). (Default: org.openapitools) - - artifactId - Generated artifact id (name of jar). - - artifactVersion - Generated artifact's package version. (Default: 1.0.0) - - enumPropertyNaming - Naming convention for enum properties: 'camelCase', 'PascalCase', 'snake_case', 'UPPERCASE', and 'original' (Default: camelCase) - - parcelizeModels - toggle "@Parcelize" for generated models - - dateLibrary - Option. Date library to use - string - String - java8 - Java 8 native JSR310 - threetenbp - Threetenbp - - collectionType - Option. Collection type to use - array - kotlin.Array - list - kotlin.collections.List - -Back to the [generators list](README.md) +--- +id: generator-opts-client-kotlin +title: Config Options for kotlin +sidebar_label: kotlin +--- + +| Option | Description | Values | Default | +| ------ | ----------- | ------ | ------- | +|sourceFolder|source folder for generated code| |src/main/kotlin| +|packageName|Generated artifact package name.| |org.openapitools| +|groupId|Generated artifact package's organization (i.e. maven groupId).| |org.openapitools| +|artifactId|Generated artifact id (name of jar).| |null| +|artifactVersion|Generated artifact's package version.| |1.0.0| +|enumPropertyNaming|Naming convention for enum properties: 'camelCase', 'PascalCase', 'snake_case', 'UPPERCASE', and 'original'| |camelCase| +|parcelizeModels|toggle "@Parcelize" for generated models| |null| +|dateLibrary|Option. Date library to use|
**string**
String
**java8**
Java 8 native JSR310
**threetenbp**
Threetenbp
|null| +|collectionType|Option. Collection type to use|
**array**
kotlin.Array
**list**
kotlin.collections.List
|null| diff --git a/docs/generators/lua.md b/docs/generators/lua.md index baf2a6d55440..6e9a4ce3f846 100644 --- a/docs/generators/lua.md +++ b/docs/generators/lua.md @@ -1,13 +1,12 @@ -CONFIG OPTIONS for lua - - packageName - Lua package name (convention: single word). (Default: openapiclient) - - packageVersion - Lua package version. (Default: 1.0.0-1) - - hideGenerationTimestamp - Hides the generation timestamp when files are generated. (Default: true) - -Back to the [generators list](README.md) +--- +id: generator-opts-client-lua +title: Config Options for lua +sidebar_label: lua +--- + +| Option | Description | Values | Default | +| ------ | ----------- | ------ | ------- | +|packageName|Lua package name (convention: single word).| |openapiclient| +|packageVersion|Lua package version.| |1.0.0-1| +|hideGenerationTimestamp|Hides the generation timestamp when files are generated.| |true| diff --git a/docs/generators/mysql-schema.md b/docs/generators/mysql-schema.md index ae70f7db075b..987e18c1cc3f 100644 --- a/docs/generators/mysql-schema.md +++ b/docs/generators/mysql-schema.md @@ -1,10 +1,11 @@ -CONFIG OPTIONS for mysql-schema - - defaultDatabaseName - Default database name for all MySQL queries (Default: ) - - jsonDataTypeEnabled - Use special JSON MySQL data type for complex model properties. Requires MySQL version 5.7.8. Generates TEXT data type when disabled (Default: true) - -Back to the [generators list](README.md) +--- +id: generator-opts-schema-mysql-schema +title: Config Options for mysql-schema +sidebar_label: mysql-schema +--- + +| Option | Description | Values | Default | +| ------ | ----------- | ------ | ------- | +|defaultDatabaseName|Default database name for all MySQL queries| || +|jsonDataTypeEnabled|Use special JSON MySQL data type for complex model properties. Requires MySQL version 5.7.8. Generates TEXT data type when disabled| |true| diff --git a/docs/generators/nodejs-server.md b/docs/generators/nodejs-server.md index c7a2ce24d446..d66e4e4f0131 100644 --- a/docs/generators/nodejs-server.md +++ b/docs/generators/nodejs-server.md @@ -1,25 +1,16 @@ -CONFIG OPTIONS for nodejs-server - - sortParamsByRequiredFlag - Sort method arguments to place required parameters before optional parameters. (Default: true) - - ensureUniqueParams - Whether to ensure parameter names are unique in an operation (rename parameters that are not). (Default: true) - - allowUnicodeIdentifiers - boolean, toggles whether unicode identifiers are allowed in names or not, default is false (Default: false) - - prependFormOrBodyParameters - Add form or body parameters to the beginning of the parameter list. (Default: false) - - googleCloudFunctions - When specified, it will generate the code which runs within Google Cloud Functions instead of standalone Node.JS server. See https://cloud.google.com/functions/docs/quickstart for the details of how to deploy the generated code. (Default: false) - - exportedName - When the generated code will be deployed to Google Cloud Functions, this option can be used to update the name of the exported function. By default, it refers to the basePath. This does not affect normal standalone nodejs server code. - - serverPort - TCP port to listen on. - -Back to the [generators list](README.md) +--- +id: generator-opts-server-nodejs-server +title: Config Options for nodejs-server +sidebar_label: nodejs-server +--- + +| Option | Description | Values | Default | +| ------ | ----------- | ------ | ------- | +|sortParamsByRequiredFlag|Sort method arguments 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| +|prependFormOrBodyParameters|Add form or body parameters to the beginning of the parameter list.| |false| +|googleCloudFunctions|When specified, it will generate the code which runs within Google Cloud Functions instead of standalone Node.JS server. See https://cloud.google.com/functions/docs/quickstart for the details of how to deploy the generated code.| |false| +|exportedName|When the generated code will be deployed to Google Cloud Functions, this option can be used to update the name of the exported function. By default, it refers to the basePath. This does not affect normal standalone nodejs server code.| |null| +|serverPort|TCP port to listen on.| |null| diff --git a/docs/generators/objc.md b/docs/generators/objc.md index 4ef100c93cb2..46d3244a130b 100644 --- a/docs/generators/objc.md +++ b/docs/generators/objc.md @@ -1,28 +1,17 @@ -CONFIG OPTIONS for objc - - coreData - Should generate core data models (Default: false) - - classPrefix - prefix for generated classes (convention: Abbreviation of pod name e.g. `HN` for `HackerNews`).` (Default: OAI) - - podName - cocoapods package name (convention: CameCase). (Default: OpenAPIClient) - - podVersion - cocoapods package version. (Default: 1.0.0) - - authorName - Name to use in the podspec file. (Default: OpenAPI) - - authorEmail - Email to use in the podspec file. (Default: team@openapitools.org) - - gitRepoURL - URL for the git repo where this podspec should point to. (Default: https://github.com/openapitools/openapi-generator) - - hideGenerationTimestamp - Hides the generation timestamp when files are generated. (Default: true) - -Back to the [generators list](README.md) +--- +id: generator-opts-client-objc +title: Config Options for objc +sidebar_label: objc +--- + +| Option | Description | Values | Default | +| ------ | ----------- | ------ | ------- | +|coreData|Should generate core data models| |false| +|classPrefix|prefix for generated classes (convention: Abbreviation of pod name e.g. `HN` for `HackerNews`).`| |OAI| +|podName|cocoapods package name (convention: CameCase).| |OpenAPIClient| +|podVersion|cocoapods package version.| |1.0.0| +|authorName|Name to use in the podspec file.| |OpenAPI| +|authorEmail|Email to use in the podspec file.| |team@openapitools.org| +|gitRepoURL|URL for the git repo where this podspec should point to.| |https://github.com/openapitools/openapi-generator| +|hideGenerationTimestamp|Hides the generation timestamp when files are generated.| |true| diff --git a/docs/generators/openapi-yaml.md b/docs/generators/openapi-yaml.md index 1bdbb8771f8b..1dfe1b9f4810 100644 --- a/docs/generators/openapi-yaml.md +++ b/docs/generators/openapi-yaml.md @@ -1,19 +1,14 @@ -CONFIG OPTIONS for openapi-yaml - - sortParamsByRequiredFlag - Sort method arguments to place required parameters before optional parameters. (Default: true) - - ensureUniqueParams - Whether to ensure parameter names are unique in an operation (rename parameters that are not). (Default: true) - - allowUnicodeIdentifiers - boolean, toggles whether unicode identifiers are allowed in names or not, default is false (Default: false) - - prependFormOrBodyParameters - Add form or body parameters to the beginning of the parameter list. (Default: false) - - outputFile - output filename - -Back to the [generators list](README.md) +--- +id: generator-opts-documentation-openapi-yaml +title: Config Options for openapi-yaml +sidebar_label: openapi-yaml +--- + +| Option | Description | Values | Default | +| ------ | ----------- | ------ | ------- | +|sortParamsByRequiredFlag|Sort method arguments 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| +|prependFormOrBodyParameters|Add form or body parameters to the beginning of the parameter list.| |false| +|outputFile|output filename| |null| diff --git a/docs/generators/openapi.md b/docs/generators/openapi.md index 8e8bb15a425f..0846d577084c 100644 --- a/docs/generators/openapi.md +++ b/docs/generators/openapi.md @@ -1,16 +1,13 @@ -CONFIG OPTIONS for openapi - - sortParamsByRequiredFlag - Sort method arguments to place required parameters before optional parameters. (Default: true) - - ensureUniqueParams - Whether to ensure parameter names are unique in an operation (rename parameters that are not). (Default: true) - - allowUnicodeIdentifiers - boolean, toggles whether unicode identifiers are allowed in names or not, default is false (Default: false) - - prependFormOrBodyParameters - Add form or body parameters to the beginning of the parameter list. (Default: false) - -Back to the [generators list](README.md) +--- +id: generator-opts-documentation-openapi +title: Config Options for openapi +sidebar_label: openapi +--- + +| Option | Description | Values | Default | +| ------ | ----------- | ------ | ------- | +|sortParamsByRequiredFlag|Sort method arguments 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| +|prependFormOrBodyParameters|Add form or body parameters to the beginning of the parameter list.| |false| diff --git a/docs/generators/perl.md b/docs/generators/perl.md index 75beaed1d1fe..b4ef17875f5e 100644 --- a/docs/generators/perl.md +++ b/docs/generators/perl.md @@ -1,22 +1,15 @@ -CONFIG OPTIONS for perl - - moduleName - Perl module name (convention: CamelCase or Long::Module). (Default: OpenAPIClient) - - moduleVersion - Perl module version. (Default: 1.0.0) - - sortParamsByRequiredFlag - Sort method arguments to place required parameters before optional parameters. (Default: true) - - ensureUniqueParams - Whether to ensure parameter names are unique in an operation (rename parameters that are not). (Default: true) - - hideGenerationTimestamp - Hides the generation timestamp when files are generated. (Default: true) - - prependFormOrBodyParameters - Add form or body parameters to the beginning of the parameter list. (Default: false) - -Back to the [generators list](README.md) +--- +id: generator-opts-client-perl +title: Config Options for perl +sidebar_label: perl +--- + +| Option | Description | Values | Default | +| ------ | ----------- | ------ | ------- | +|moduleName|Perl module name (convention: CamelCase or Long::Module).| |OpenAPIClient| +|moduleVersion|Perl module version.| |1.0.0| +|sortParamsByRequiredFlag|Sort method arguments 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| +|hideGenerationTimestamp|Hides the generation timestamp when files are generated.| |true| +|prependFormOrBodyParameters|Add form or body parameters to the beginning of the parameter list.| |false| diff --git a/docs/generators/php-laravel.md b/docs/generators/php-laravel.md index 7a4ae180b583..24f1ea9e8ebc 100644 --- a/docs/generators/php-laravel.md +++ b/docs/generators/php-laravel.md @@ -1,43 +1,22 @@ -CONFIG OPTIONS for php-laravel - - sortParamsByRequiredFlag - Sort method arguments to place required parameters before optional parameters. (Default: true) - - ensureUniqueParams - Whether to ensure parameter names are unique in an operation (rename parameters that are not). (Default: true) - - allowUnicodeIdentifiers - boolean, toggles whether unicode identifiers are allowed in names or not, default is false (Default: false) - - prependFormOrBodyParameters - Add form or body parameters to the beginning of the parameter list. (Default: false) - - modelPackage - package for generated models - - apiPackage - package for generated api classes - - variableNamingConvention - naming convention of variable name, e.g. camelCase. (Default: snake_case) - - invokerPackage - The main namespace to use for all classes. e.g. Yay\Pets - - packageName - The main package name for classes. e.g. GeneratedPetstore - - srcBasePath - The directory to serve as source root. - - gitUserId - Git user ID, e.g. openapitools. - - gitRepoId - Git repo ID, e.g. openapi-generator. - - artifactVersion - The version to use in the composer package version field. e.g. 1.2.3 - -Back to the [generators list](README.md) +--- +id: generator-opts-server-php-laravel +title: Config Options for php-laravel +sidebar_label: php-laravel +--- + +| Option | Description | Values | Default | +| ------ | ----------- | ------ | ------- | +|sortParamsByRequiredFlag|Sort method arguments 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| +|prependFormOrBodyParameters|Add form or body parameters to the beginning of the parameter list.| |false| +|modelPackage|package for generated models| |null| +|apiPackage|package for generated api classes| |null| +|variableNamingConvention|naming convention of variable name, e.g. camelCase.| |snake_case| +|invokerPackage|The main namespace to use for all classes. e.g. Yay\Pets| |null| +|packageName|The main package name for classes. e.g. GeneratedPetstore| |null| +|srcBasePath|The directory to serve as source root.| |null| +|gitUserId|Git user ID, e.g. openapitools.| |null| +|gitRepoId|Git repo ID, e.g. openapi-generator.| |null| +|artifactVersion|The version to use in the composer package version field. e.g. 1.2.3| |null| diff --git a/docs/generators/php-lumen.md b/docs/generators/php-lumen.md index 10d0a3af2092..50590014ceb0 100644 --- a/docs/generators/php-lumen.md +++ b/docs/generators/php-lumen.md @@ -1,43 +1,22 @@ -CONFIG OPTIONS for php-lumen - - sortParamsByRequiredFlag - Sort method arguments to place required parameters before optional parameters. (Default: true) - - ensureUniqueParams - Whether to ensure parameter names are unique in an operation (rename parameters that are not). (Default: true) - - allowUnicodeIdentifiers - boolean, toggles whether unicode identifiers are allowed in names or not, default is false (Default: false) - - prependFormOrBodyParameters - Add form or body parameters to the beginning of the parameter list. (Default: false) - - modelPackage - package for generated models - - apiPackage - package for generated api classes - - variableNamingConvention - naming convention of variable name, e.g. camelCase. (Default: snake_case) - - invokerPackage - The main namespace to use for all classes. e.g. Yay\Pets - - packageName - The main package name for classes. e.g. GeneratedPetstore - - srcBasePath - The directory to serve as source root. - - gitUserId - Git user ID, e.g. openapitools. - - gitRepoId - Git repo ID, e.g. openapi-generator. - - artifactVersion - The version to use in the composer package version field. e.g. 1.2.3 - -Back to the [generators list](README.md) +--- +id: generator-opts-server-php-lumen +title: Config Options for php-lumen +sidebar_label: php-lumen +--- + +| Option | Description | Values | Default | +| ------ | ----------- | ------ | ------- | +|sortParamsByRequiredFlag|Sort method arguments 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| +|prependFormOrBodyParameters|Add form or body parameters to the beginning of the parameter list.| |false| +|modelPackage|package for generated models| |null| +|apiPackage|package for generated api classes| |null| +|variableNamingConvention|naming convention of variable name, e.g. camelCase.| |snake_case| +|invokerPackage|The main namespace to use for all classes. e.g. Yay\Pets| |null| +|packageName|The main package name for classes. e.g. GeneratedPetstore| |null| +|srcBasePath|The directory to serve as source root.| |null| +|gitUserId|Git user ID, e.g. openapitools.| |null| +|gitRepoId|Git repo ID, e.g. openapi-generator.| |null| +|artifactVersion|The version to use in the composer package version field. e.g. 1.2.3| |null| diff --git a/docs/generators/php-silex.md b/docs/generators/php-silex.md index c7c8705b294c..e417df414b02 100644 --- a/docs/generators/php-silex.md +++ b/docs/generators/php-silex.md @@ -1,16 +1,13 @@ -CONFIG OPTIONS for php-silex - - sortParamsByRequiredFlag - Sort method arguments to place required parameters before optional parameters. (Default: true) - - ensureUniqueParams - Whether to ensure parameter names are unique in an operation (rename parameters that are not). (Default: true) - - allowUnicodeIdentifiers - boolean, toggles whether unicode identifiers are allowed in names or not, default is false (Default: false) - - prependFormOrBodyParameters - Add form or body parameters to the beginning of the parameter list. (Default: false) - -Back to the [generators list](README.md) +--- +id: generator-opts-server-php-silex +title: Config Options for php-silex +sidebar_label: php-silex +--- + +| Option | Description | Values | Default | +| ------ | ----------- | ------ | ------- | +|sortParamsByRequiredFlag|Sort method arguments 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| +|prependFormOrBodyParameters|Add form or body parameters to the beginning of the parameter list.| |false| diff --git a/docs/generators/php-slim.md b/docs/generators/php-slim.md index 629056bb928a..fd7139180684 100644 --- a/docs/generators/php-slim.md +++ b/docs/generators/php-slim.md @@ -1,46 +1,23 @@ -CONFIG OPTIONS for php-slim - - sortParamsByRequiredFlag - Sort method arguments to place required parameters before optional parameters. (Default: true) - - ensureUniqueParams - Whether to ensure parameter names are unique in an operation (rename parameters that are not). (Default: true) - - allowUnicodeIdentifiers - boolean, toggles whether unicode identifiers are allowed in names or not, default is false (Default: false) - - prependFormOrBodyParameters - Add form or body parameters to the beginning of the parameter list. (Default: false) - - modelPackage - package for generated models - - apiPackage - package for generated api classes - - variableNamingConvention - naming convention of variable name, e.g. camelCase. (Default: camelCase) - - invokerPackage - The main namespace to use for all classes. e.g. Yay\Pets - - packageName - The main package name for classes. e.g. GeneratedPetstore - - srcBasePath - The directory to serve as source root. - - gitUserId - Git user ID, e.g. openapitools. - - gitRepoId - Git repo ID, e.g. openapi-generator. - - artifactVersion - The version to use in the composer package version field. e.g. 1.2.3 - - phpcsStandard - PHP CodeSniffer option. Accepts name or path of the coding standard to use. (Default: PSR12) - -Back to the [generators list](README.md) +--- +id: generator-opts-server-php-slim +title: Config Options for php-slim +sidebar_label: php-slim +--- + +| Option | Description | Values | Default | +| ------ | ----------- | ------ | ------- | +|sortParamsByRequiredFlag|Sort method arguments 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| +|prependFormOrBodyParameters|Add form or body parameters to the beginning of the parameter list.| |false| +|modelPackage|package for generated models| |null| +|apiPackage|package for generated api classes| |null| +|variableNamingConvention|naming convention of variable name, e.g. camelCase.| |camelCase| +|invokerPackage|The main namespace to use for all classes. e.g. Yay\Pets| |null| +|packageName|The main package name for classes. e.g. GeneratedPetstore| |null| +|srcBasePath|The directory to serve as source root.| |null| +|gitUserId|Git user ID, e.g. openapitools.| |null| +|gitRepoId|Git repo ID, e.g. openapi-generator.| |null| +|artifactVersion|The version to use in the composer package version field. e.g. 1.2.3| |null| +|phpcsStandard|PHP CodeSniffer <standard> option. Accepts name or path of the coding standard to use.| |PSR12| diff --git a/docs/generators/php-symfony.md b/docs/generators/php-symfony.md index f85157e9c15e..be48e605b5eb 100644 --- a/docs/generators/php-symfony.md +++ b/docs/generators/php-symfony.md @@ -1,58 +1,27 @@ -CONFIG OPTIONS for php-symfony - - sortParamsByRequiredFlag - Sort method arguments to place required parameters before optional parameters. (Default: true) - - ensureUniqueParams - Whether to ensure parameter names are unique in an operation (rename parameters that are not). (Default: true) - - allowUnicodeIdentifiers - boolean, toggles whether unicode identifiers are allowed in names or not, default is false (Default: false) - - prependFormOrBodyParameters - Add form or body parameters to the beginning of the parameter list. (Default: false) - - modelPackage - package for generated models - - apiPackage - package for generated api classes - - variableNamingConvention - naming convention of variable name, e.g. camelCase. (Default: snake_case) - - invokerPackage - The main namespace to use for all classes. e.g. Yay\Pets - - packageName - The main package name for classes. e.g. GeneratedPetstore - - srcBasePath - The directory to serve as source root. - - gitUserId - Git user ID, e.g. openapitools. - - gitRepoId - Git repo ID, e.g. openapi-generator. - - artifactVersion - The version to use in the composer package version field. e.g. 1.2.3 - - composerVendorName - The vendor name used in the composer package name. The template uses {{composerVendorName}}/{{composerProjectName}} for the composer package name. e.g. yaypets - - bundleName - The name of the Symfony bundle. The template uses {{bundleName}} - - composerProjectName - The project name used in the composer package name. The template uses {{composerVendorName}}/{{composerProjectName}} for the composer package name. e.g. petstore-client - - hideGenerationTimestamp - Hides the generation timestamp when files are generated. (Default: true) - - phpLegacySupport - Should the generated code be compatible with PHP 5.x? (Default: true) - -Back to the [generators list](README.md) +--- +id: generator-opts-server-php-symfony +title: Config Options for php-symfony +sidebar_label: php-symfony +--- + +| Option | Description | Values | Default | +| ------ | ----------- | ------ | ------- | +|sortParamsByRequiredFlag|Sort method arguments 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| +|prependFormOrBodyParameters|Add form or body parameters to the beginning of the parameter list.| |false| +|modelPackage|package for generated models| |null| +|apiPackage|package for generated api classes| |null| +|variableNamingConvention|naming convention of variable name, e.g. camelCase.| |snake_case| +|invokerPackage|The main namespace to use for all classes. e.g. Yay\Pets| |null| +|packageName|The main package name for classes. e.g. GeneratedPetstore| |null| +|srcBasePath|The directory to serve as source root.| |null| +|gitUserId|Git user ID, e.g. openapitools.| |null| +|gitRepoId|Git repo ID, e.g. openapi-generator.| |null| +|artifactVersion|The version to use in the composer package version field. e.g. 1.2.3| |null| +|composerVendorName|The vendor name used in the composer package name. The template uses {{composerVendorName}}/{{composerProjectName}} for the composer package name. e.g. yaypets| |null| +|bundleName|The name of the Symfony bundle. The template uses {{bundleName}}| |null| +|composerProjectName|The project name used in the composer package name. The template uses {{composerVendorName}}/{{composerProjectName}} for the composer package name. e.g. petstore-client| |null| +|hideGenerationTimestamp|Hides the generation timestamp when files are generated.| |true| +|phpLegacySupport|Should the generated code be compatible with PHP 5.x?| |true| diff --git a/docs/generators/php-ze-ph.md b/docs/generators/php-ze-ph.md index c920817d2aa2..14ae8554ace7 100644 --- a/docs/generators/php-ze-ph.md +++ b/docs/generators/php-ze-ph.md @@ -1,43 +1,22 @@ -CONFIG OPTIONS for php-ze-ph - - sortParamsByRequiredFlag - Sort method arguments to place required parameters before optional parameters. (Default: true) - - ensureUniqueParams - Whether to ensure parameter names are unique in an operation (rename parameters that are not). (Default: true) - - allowUnicodeIdentifiers - boolean, toggles whether unicode identifiers are allowed in names or not, default is false (Default: false) - - prependFormOrBodyParameters - Add form or body parameters to the beginning of the parameter list. (Default: false) - - modelPackage - package for generated models - - apiPackage - package for generated api classes - - variableNamingConvention - naming convention of variable name, e.g. camelCase. (Default: snake_case) - - invokerPackage - The main namespace to use for all classes. e.g. Yay\Pets - - packageName - The main package name for classes. e.g. GeneratedPetstore - - srcBasePath - The directory to serve as source root. - - gitUserId - Git user ID, e.g. openapitools. - - gitRepoId - Git repo ID, e.g. openapi-generator. - - artifactVersion - The version to use in the composer package version field. e.g. 1.2.3 - -Back to the [generators list](README.md) +--- +id: generator-opts-server-php-ze-ph +title: Config Options for php-ze-ph +sidebar_label: php-ze-ph +--- + +| Option | Description | Values | Default | +| ------ | ----------- | ------ | ------- | +|sortParamsByRequiredFlag|Sort method arguments 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| +|prependFormOrBodyParameters|Add form or body parameters to the beginning of the parameter list.| |false| +|modelPackage|package for generated models| |null| +|apiPackage|package for generated api classes| |null| +|variableNamingConvention|naming convention of variable name, e.g. camelCase.| |snake_case| +|invokerPackage|The main namespace to use for all classes. e.g. Yay\Pets| |null| +|packageName|The main package name for classes. e.g. GeneratedPetstore| |null| +|srcBasePath|The directory to serve as source root.| |null| +|gitUserId|Git user ID, e.g. openapitools.| |null| +|gitRepoId|Git repo ID, e.g. openapi-generator.| |null| +|artifactVersion|The version to use in the composer package version field. e.g. 1.2.3| |null| diff --git a/docs/generators/php.md b/docs/generators/php.md index 8604127fd832..0172100d360a 100644 --- a/docs/generators/php.md +++ b/docs/generators/php.md @@ -1,52 +1,25 @@ -CONFIG OPTIONS for php - - sortParamsByRequiredFlag - Sort method arguments to place required parameters before optional parameters. (Default: true) - - ensureUniqueParams - Whether to ensure parameter names are unique in an operation (rename parameters that are not). (Default: true) - - allowUnicodeIdentifiers - boolean, toggles whether unicode identifiers are allowed in names or not, default is false (Default: false) - - prependFormOrBodyParameters - Add form or body parameters to the beginning of the parameter list. (Default: false) - - modelPackage - package for generated models - - apiPackage - package for generated api classes - - variableNamingConvention - naming convention of variable name, e.g. camelCase. (Default: snake_case) - - invokerPackage - The main namespace to use for all classes. e.g. Yay\Pets - - packageName - The main package name for classes. e.g. GeneratedPetstore - - srcBasePath - The directory to serve as source root. - - gitUserId - Git user ID, e.g. openapitools. - - gitRepoId - Git repo ID, e.g. openapi-generator. - - artifactVersion - The version to use in the composer package version field. e.g. 1.2.3 - - composerVendorName - The vendor name used in the composer package name. The template uses {{composerVendorName}}/{{composerProjectName}} for the composer package name. e.g. yaypets. IMPORTANT NOTE (2016/03): composerVendorName will be deprecated and replaced by gitUserId in the next openapi-generator release - - composerProjectName - The project name used in the composer package name. The template uses {{composerVendorName}}/{{composerProjectName}} for the composer package name. e.g. petstore-client. IMPORTANT NOTE (2016/03): composerProjectName will be deprecated and replaced by gitRepoId in the next openapi-generator release - - hideGenerationTimestamp - boolean, toggles whether unicode identifiers are allowed in names or not, default is false (Default: true) - -Back to the [generators list](README.md) +--- +id: generator-opts-client-php +title: Config Options for php +sidebar_label: php +--- + +| Option | Description | Values | Default | +| ------ | ----------- | ------ | ------- | +|sortParamsByRequiredFlag|Sort method arguments 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| +|prependFormOrBodyParameters|Add form or body parameters to the beginning of the parameter list.| |false| +|modelPackage|package for generated models| |null| +|apiPackage|package for generated api classes| |null| +|variableNamingConvention|naming convention of variable name, e.g. camelCase.| |snake_case| +|invokerPackage|The main namespace to use for all classes. e.g. Yay\Pets| |null| +|packageName|The main package name for classes. e.g. GeneratedPetstore| |null| +|srcBasePath|The directory to serve as source root.| |null| +|gitUserId|Git user ID, e.g. openapitools.| |null| +|gitRepoId|Git repo ID, e.g. openapi-generator.| |null| +|artifactVersion|The version to use in the composer package version field. e.g. 1.2.3| |null| +|composerVendorName|The vendor name used in the composer package name. The template uses {{composerVendorName}}/{{composerProjectName}} for the composer package name. e.g. yaypets. IMPORTANT NOTE (2016/03): composerVendorName will be deprecated and replaced by gitUserId in the next openapi-generator release| |null| +|composerProjectName|The project name used in the composer package name. The template uses {{composerVendorName}}/{{composerProjectName}} for the composer package name. e.g. petstore-client. IMPORTANT NOTE (2016/03): composerProjectName will be deprecated and replaced by gitRepoId in the next openapi-generator release| |null| +|hideGenerationTimestamp|boolean, toggles whether unicode identifiers are allowed in names or not, default is false| |true| diff --git a/docs/generators/powershell.md b/docs/generators/powershell.md index 8fdc4171cc6b..2468c0a0853c 100644 --- a/docs/generators/powershell.md +++ b/docs/generators/powershell.md @@ -1,13 +1,12 @@ -CONFIG OPTIONS for powershell - - packageName - Client package name (e.g. org.openapitools.client). (Default: Org.OpenAPITools) - - packageGuid - GUID for PowerShell module (e.g. a27b908d-2a20-467f-bc32-af6f3a654ac5). A random GUID will be generated by default. - - csharpClientPath - Path to the C# API client generated by OpenAPI Generator, e.g. $ScriptDir\..\csharp\OpenAPIClient where $ScriptDir is the current directory. NOTE: you will need to generate the C# API client separately. (Default: $ScriptDir\csharp\OpenAPIClient) - -Back to the [generators list](README.md) +--- +id: generator-opts-client-powershell +title: Config Options for powershell +sidebar_label: powershell +--- + +| Option | Description | Values | Default | +| ------ | ----------- | ------ | ------- | +|packageName|Client package name (e.g. org.openapitools.client).| |Org.OpenAPITools| +|packageGuid|GUID for PowerShell module (e.g. a27b908d-2a20-467f-bc32-af6f3a654ac5). A random GUID will be generated by default.| |null| +|csharpClientPath|Path to the C# API client generated by OpenAPI Generator, e.g. $ScriptDir\..\csharp\OpenAPIClient where $ScriptDir is the current directory. NOTE: you will need to generate the C# API client separately.| |$ScriptDir\csharp\OpenAPIClient| diff --git a/docs/generators/python-flask.md b/docs/generators/python-flask.md index 113916f815ea..32d1d913be99 100644 --- a/docs/generators/python-flask.md +++ b/docs/generators/python-flask.md @@ -1,34 +1,19 @@ -CONFIG OPTIONS for python-flask - - sortParamsByRequiredFlag - Sort method arguments to place required parameters before optional parameters. (Default: true) - - ensureUniqueParams - Whether to ensure parameter names are unique in an operation (rename parameters that are not). (Default: true) - - allowUnicodeIdentifiers - boolean, toggles whether unicode identifiers are allowed in names or not, default is false (Default: false) - - prependFormOrBodyParameters - Add form or body parameters to the beginning of the parameter list. (Default: false) - - packageName - python package name (convention: snake_case). (Default: openapi_server) - - packageVersion - python package version. (Default: 1.0.0) - - controllerPackage - controller package (Default: controllers) - - defaultController - default controller (Default: default_controller) - - supportPython2 - support python2 (Default: false) - - serverPort - TCP port to listen to in app.run (Default: 8080) - -Back to the [generators list](README.md) +--- +id: generator-opts-server-python-flask +title: Config Options for python-flask +sidebar_label: python-flask +--- + +| Option | Description | Values | Default | +| ------ | ----------- | ------ | ------- | +|sortParamsByRequiredFlag|Sort method arguments 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| +|prependFormOrBodyParameters|Add form or body parameters to the beginning of the parameter list.| |false| +|packageName|python package name (convention: snake_case).| |openapi_server| +|packageVersion|python package version.| |1.0.0| +|controllerPackage|controller package| |controllers| +|defaultController|default controller| |default_controller| +|supportPython2|support python2| |false| +|serverPort|TCP port to listen to in app.run| |8080| diff --git a/docs/generators/python.md b/docs/generators/python.md index 7eebca2137d1..ea43f3be0c26 100644 --- a/docs/generators/python.md +++ b/docs/generators/python.md @@ -1,28 +1,17 @@ -CONFIG OPTIONS for python - - packageName - python package name (convention: snake_case). (Default: openapi_client) - - projectName - python project name in setup.py (e.g. petstore-api). - - packageVersion - python package version. (Default: 1.0.0) - - packageUrl - python package URL. - - sortParamsByRequiredFlag - Sort method arguments to place required parameters before optional parameters. (Default: true) - - hideGenerationTimestamp - Hides the generation timestamp when files are generated. (Default: true) - - generateSourceCodeOnly - Specifies that only a library source code is to be generated. (Default: false) - - library - library template (sub-template) to use: asyncio, tornado, urllib3 (Default: urllib3) - -Back to the [generators list](README.md) +--- +id: generator-opts-client-python +title: Config Options for python +sidebar_label: python +--- + +| Option | Description | Values | Default | +| ------ | ----------- | ------ | ------- | +|packageName|python package name (convention: snake_case).| |openapi_client| +|projectName|python project name in setup.py (e.g. petstore-api).| |null| +|packageVersion|python package version.| |1.0.0| +|packageUrl|python package URL.| |null| +|sortParamsByRequiredFlag|Sort method arguments to place required parameters before optional parameters.| |true| +|hideGenerationTimestamp|Hides the generation timestamp when files are generated.| |true| +|generateSourceCodeOnly|Specifies that only a library source code is to be generated.| |false| +|library|library template (sub-template) to use: asyncio, tornado, urllib3| |urllib3| diff --git a/docs/generators/r.md b/docs/generators/r.md index 8253566f41f0..3265db5cafdd 100644 --- a/docs/generators/r.md +++ b/docs/generators/r.md @@ -1,13 +1,12 @@ -CONFIG OPTIONS for r - - packageName - R package name (convention: lowercase). (Default: openapi) - - packageVersion - R package version. (Default: 1.0.0) - - hideGenerationTimestamp - Hides the generation timestamp when files are generated. (Default: true) - -Back to the [generators list](README.md) +--- +id: generator-opts-client-r +title: Config Options for r +sidebar_label: r +--- + +| Option | Description | Values | Default | +| ------ | ----------- | ------ | ------- | +|packageName|R package name (convention: lowercase).| |openapi| +|packageVersion|R package version.| |1.0.0| +|hideGenerationTimestamp|Hides the generation timestamp when files are generated.| |true| diff --git a/docs/generators/ruby-on-rails.md b/docs/generators/ruby-on-rails.md index b32fc0a017e0..8f7425fb0f77 100644 --- a/docs/generators/ruby-on-rails.md +++ b/docs/generators/ruby-on-rails.md @@ -1,7 +1,10 @@ -CONFIG OPTIONS for ruby-on-rails +--- +id: generator-opts-server-ruby-on-rails +title: Config Options for ruby-on-rails +sidebar_label: ruby-on-rails +--- - databaseAdapter - The adapter for database (e.g. mysql, sqlite). Default: sqlite (Default: sqlite) - -Back to the [generators list](README.md) +| Option | Description | Values | Default | +| ------ | ----------- | ------ | ------- | +|databaseAdapter|The adapter for database (e.g. mysql, sqlite). Default: sqlite| |sqlite| diff --git a/docs/generators/ruby-sinatra.md b/docs/generators/ruby-sinatra.md index 9603ad756185..c14f4e4c182d 100644 --- a/docs/generators/ruby-sinatra.md +++ b/docs/generators/ruby-sinatra.md @@ -1,4 +1,9 @@ -CONFIG OPTIONS for ruby-sinatra +--- +id: generator-opts-server-ruby-sinatra +title: Config Options for ruby-sinatra +sidebar_label: ruby-sinatra +--- -Back to the [generators list](README.md) +| Option | Description | Values | Default | +| ------ | ----------- | ------ | ------- | diff --git a/docs/generators/ruby.md b/docs/generators/ruby.md index 97719919a72c..356285065d48 100644 --- a/docs/generators/ruby.md +++ b/docs/generators/ruby.md @@ -1,49 +1,24 @@ -CONFIG OPTIONS for ruby - - sortParamsByRequiredFlag - Sort method arguments to place required parameters before optional parameters. (Default: true) - - ensureUniqueParams - Whether to ensure parameter names are unique in an operation (rename parameters that are not). (Default: true) - - allowUnicodeIdentifiers - boolean, toggles whether unicode identifiers are allowed in names or not, default is false (Default: false) - - prependFormOrBodyParameters - Add form or body parameters to the beginning of the parameter list. (Default: false) - - gemName - gem name (convention: underscore_case). (Default: openapi_client) - - moduleName - top module name (convention: CamelCase, usually corresponding to gem name). (Default: OpenAPIClient) - - gemVersion - gem version. (Default: 1.0.0) - - gemLicense - gem license. (Default: proprietary) - - gemRequiredRubyVersion - gem required Ruby version. (Default: >= 1.9) - - gemHomepage - gem homepage. (Default: http://org.openapitools) - - gemSummary - gem summary. (Default: A ruby wrapper for the REST APIs) - - gemDescription - gem description. (Default: This gem maps to a REST API) - - gemAuthor - gem author (only one is supported). - - gemAuthorEmail - gem author email (only one is supported). - - hideGenerationTimestamp - Hides the generation timestamp when files are generated. (Default: true) - -Back to the [generators list](README.md) +--- +id: generator-opts-client-ruby +title: Config Options for ruby +sidebar_label: ruby +--- + +| Option | Description | Values | Default | +| ------ | ----------- | ------ | ------- | +|sortParamsByRequiredFlag|Sort method arguments 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| +|prependFormOrBodyParameters|Add form or body parameters to the beginning of the parameter list.| |false| +|gemName|gem name (convention: underscore_case).| |openapi_client| +|moduleName|top module name (convention: CamelCase, usually corresponding to gem name).| |OpenAPIClient| +|gemVersion|gem version.| |1.0.0| +|gemLicense|gem license. | |proprietary| +|gemRequiredRubyVersion|gem required Ruby version. | |>= 1.9| +|gemHomepage|gem homepage. | |http://org.openapitools| +|gemSummary|gem summary. | |A ruby wrapper for the REST APIs| +|gemDescription|gem description. | |This gem maps to a REST API| +|gemAuthor|gem author (only one is supported).| |null| +|gemAuthorEmail|gem author email (only one is supported).| |null| +|hideGenerationTimestamp|Hides the generation timestamp when files are generated.| |true| diff --git a/docs/generators/rust-server.md b/docs/generators/rust-server.md index 8be0e99e1ceb..ebffe75be40e 100644 --- a/docs/generators/rust-server.md +++ b/docs/generators/rust-server.md @@ -1,10 +1,11 @@ -CONFIG OPTIONS for rust-server - - packageName - Rust crate name (convention: snake_case). (Default: openapi_client) - - packageVersion - Rust crate version. - -Back to the [generators list](README.md) +--- +id: generator-opts-server-rust-server +title: Config Options for rust-server +sidebar_label: rust-server +--- + +| Option | Description | Values | Default | +| ------ | ----------- | ------ | ------- | +|packageName|Rust crate name (convention: snake_case).| |openapi_client| +|packageVersion|Rust crate version.| |null| diff --git a/docs/generators/rust.md b/docs/generators/rust.md index c126505e9816..8841b9012381 100644 --- a/docs/generators/rust.md +++ b/docs/generators/rust.md @@ -1,18 +1,13 @@ -CONFIG OPTIONS for rust - - packageName - Rust package name (convention: lowercase). (Default: openapi) - - packageVersion - Rust package version. (Default: 1.0.0) - - hideGenerationTimestamp - Hides the generation timestamp when files are generated. (Default: true) - - library - library template (sub-template) to use. (Default: hyper) - hyper - HTTP client: Hyper. - reqwest - HTTP client: Reqwest. - -Back to the [generators list](README.md) +--- +id: generator-opts-client-rust +title: Config Options for rust +sidebar_label: rust +--- + +| Option | Description | Values | Default | +| ------ | ----------- | ------ | ------- | +|packageName|Rust package name (convention: lowercase).| |openapi| +|packageVersion|Rust package version.| |1.0.0| +|hideGenerationTimestamp|Hides the generation timestamp when files are generated.| |true| +|library|library template (sub-template) to use.|
**hyper**
HTTP client: Hyper.
**reqwest**
HTTP client: Reqwest.
|hyper| diff --git a/docs/generators/scala-akka.md b/docs/generators/scala-akka.md index 4c53a0dbcb77..28229859c83a 100644 --- a/docs/generators/scala-akka.md +++ b/docs/generators/scala-akka.md @@ -1,28 +1,17 @@ -CONFIG OPTIONS for scala-akka - - sortParamsByRequiredFlag - Sort method arguments to place required parameters before optional parameters. (Default: true) - - ensureUniqueParams - Whether to ensure parameter names are unique in an operation (rename parameters that are not). (Default: true) - - allowUnicodeIdentifiers - boolean, toggles whether unicode identifiers are allowed in names or not, default is false (Default: false) - - prependFormOrBodyParameters - Add form or body parameters to the beginning of the parameter list. (Default: false) - - modelPackage - package for generated models - - apiPackage - package for generated api classes - - sourceFolder - source folder for generated code - - mainPackage - Top-level package name, which defines 'apiPackage', 'modelPackage', 'invokerPackage' (Default: org.openapitools.client) - -Back to the [generators list](README.md) +--- +id: generator-opts-client-scala-akka +title: Config Options for scala-akka +sidebar_label: scala-akka +--- + +| Option | Description | Values | Default | +| ------ | ----------- | ------ | ------- | +|sortParamsByRequiredFlag|Sort method arguments 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| +|prependFormOrBodyParameters|Add form or body parameters to the beginning of the parameter list.| |false| +|modelPackage|package for generated models| |null| +|apiPackage|package for generated api classes| |null| +|sourceFolder|source folder for generated code| |null| +|mainPackage|Top-level package name, which defines 'apiPackage', 'modelPackage', 'invokerPackage'| |org.openapitools.client| diff --git a/docs/generators/scala-finch.md b/docs/generators/scala-finch.md index a6f40be09f39..7680f37b1108 100644 --- a/docs/generators/scala-finch.md +++ b/docs/generators/scala-finch.md @@ -1,13 +1,12 @@ -CONFIG OPTIONS for scala-finch - - packageName - Finch package name (e.g. org.openapitools). (Default: org.openapitools) - - modelPackage - package for generated models - - apiPackage - package for generated api classes - -Back to the [generators list](README.md) +--- +id: generator-opts-server-scala-finch +title: Config Options for scala-finch +sidebar_label: scala-finch +--- + +| Option | Description | Values | Default | +| ------ | ----------- | ------ | ------- | +|packageName|Finch package name (e.g. org.openapitools).| |org.openapitools| +|modelPackage|package for generated models| |null| +|apiPackage|package for generated api classes| |null| diff --git a/docs/generators/scala-gatling.md b/docs/generators/scala-gatling.md index e12674ccd2cb..aa2fda8f9cd3 100644 --- a/docs/generators/scala-gatling.md +++ b/docs/generators/scala-gatling.md @@ -1,25 +1,16 @@ -CONFIG OPTIONS for scala-gatling - - sortParamsByRequiredFlag - Sort method arguments to place required parameters before optional parameters. (Default: true) - - ensureUniqueParams - Whether to ensure parameter names are unique in an operation (rename parameters that are not). (Default: true) - - allowUnicodeIdentifiers - boolean, toggles whether unicode identifiers are allowed in names or not, default is false (Default: false) - - prependFormOrBodyParameters - Add form or body parameters to the beginning of the parameter list. (Default: false) - - modelPackage - package for generated models - - apiPackage - package for generated api classes - - sourceFolder - source folder for generated code - -Back to the [generators list](README.md) +--- +id: generator-opts-client-scala-gatling +title: Config Options for scala-gatling +sidebar_label: scala-gatling +--- + +| Option | Description | Values | Default | +| ------ | ----------- | ------ | ------- | +|sortParamsByRequiredFlag|Sort method arguments 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| +|prependFormOrBodyParameters|Add form or body parameters to the beginning of the parameter list.| |false| +|modelPackage|package for generated models| |null| +|apiPackage|package for generated api classes| |null| +|sourceFolder|source folder for generated code| |null| diff --git a/docs/generators/scala-httpclient.md b/docs/generators/scala-httpclient.md index a21cee7caa3b..6b85507bc29d 100644 --- a/docs/generators/scala-httpclient.md +++ b/docs/generators/scala-httpclient.md @@ -1,28 +1,17 @@ -CONFIG OPTIONS for scala-httpclient - - sortParamsByRequiredFlag - Sort method arguments to place required parameters before optional parameters. (Default: true) - - ensureUniqueParams - Whether to ensure parameter names are unique in an operation (rename parameters that are not). (Default: true) - - allowUnicodeIdentifiers - boolean, toggles whether unicode identifiers are allowed in names or not, default is false (Default: false) - - prependFormOrBodyParameters - Add form or body parameters to the beginning of the parameter list. (Default: false) - - modelPackage - package for generated models - - apiPackage - package for generated api classes - - sourceFolder - source folder for generated code - - modelPropertyNaming - Naming convention for the property: 'camelCase', 'PascalCase', 'snake_case' and 'original', which keeps the original name (Default: camelCase) - -Back to the [generators list](README.md) +--- +id: generator-opts-client-scala-httpclient +title: Config Options for scala-httpclient +sidebar_label: scala-httpclient +--- + +| Option | Description | Values | Default | +| ------ | ----------- | ------ | ------- | +|sortParamsByRequiredFlag|Sort method arguments 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| +|prependFormOrBodyParameters|Add form or body parameters to the beginning of the parameter list.| |false| +|modelPackage|package for generated models| |null| +|apiPackage|package for generated api classes| |null| +|sourceFolder|source folder for generated code| |null| +|modelPropertyNaming|Naming convention for the property: 'camelCase', 'PascalCase', 'snake_case' and 'original', which keeps the original name| |camelCase| diff --git a/docs/generators/scala-lagom-server.md b/docs/generators/scala-lagom-server.md index 3c9beeb49612..f6b6a51df529 100644 --- a/docs/generators/scala-lagom-server.md +++ b/docs/generators/scala-lagom-server.md @@ -1,28 +1,17 @@ -CONFIG OPTIONS for scala-lagom-server - - sortParamsByRequiredFlag - Sort method arguments to place required parameters before optional parameters. (Default: true) - - ensureUniqueParams - Whether to ensure parameter names are unique in an operation (rename parameters that are not). (Default: true) - - allowUnicodeIdentifiers - boolean, toggles whether unicode identifiers are allowed in names or not, default is false (Default: false) - - prependFormOrBodyParameters - Add form or body parameters to the beginning of the parameter list. (Default: false) - - modelPackage - package for generated models - - apiPackage - package for generated api classes - - sourceFolder - source folder for generated code - - modelPropertyNaming - Naming convention for the property: 'camelCase', 'PascalCase', 'snake_case' and 'original', which keeps the original name (Default: camelCase) - -Back to the [generators list](README.md) +--- +id: generator-opts-server-scala-lagom-server +title: Config Options for scala-lagom-server +sidebar_label: scala-lagom-server +--- + +| Option | Description | Values | Default | +| ------ | ----------- | ------ | ------- | +|sortParamsByRequiredFlag|Sort method arguments 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| +|prependFormOrBodyParameters|Add form or body parameters to the beginning of the parameter list.| |false| +|modelPackage|package for generated models| |null| +|apiPackage|package for generated api classes| |null| +|sourceFolder|source folder for generated code| |null| +|modelPropertyNaming|Naming convention for the property: 'camelCase', 'PascalCase', 'snake_case' and 'original', which keeps the original name| |camelCase| diff --git a/docs/generators/scalatra.md b/docs/generators/scalatra.md index b512627bfceb..64d8e2ca9871 100644 --- a/docs/generators/scalatra.md +++ b/docs/generators/scalatra.md @@ -1,25 +1,16 @@ -CONFIG OPTIONS for scalatra - - sortParamsByRequiredFlag - Sort method arguments to place required parameters before optional parameters. (Default: true) - - ensureUniqueParams - Whether to ensure parameter names are unique in an operation (rename parameters that are not). (Default: true) - - allowUnicodeIdentifiers - boolean, toggles whether unicode identifiers are allowed in names or not, default is false (Default: false) - - prependFormOrBodyParameters - Add form or body parameters to the beginning of the parameter list. (Default: false) - - modelPackage - package for generated models - - apiPackage - package for generated api classes - - sourceFolder - source folder for generated code - -Back to the [generators list](README.md) +--- +id: generator-opts-server-scalatra +title: Config Options for scalatra +sidebar_label: scalatra +--- + +| Option | Description | Values | Default | +| ------ | ----------- | ------ | ------- | +|sortParamsByRequiredFlag|Sort method arguments 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| +|prependFormOrBodyParameters|Add form or body parameters to the beginning of the parameter list.| |false| +|modelPackage|package for generated models| |null| +|apiPackage|package for generated api classes| |null| +|sourceFolder|source folder for generated code| |null| diff --git a/docs/generators/scalaz.md b/docs/generators/scalaz.md index eec98a7a7c53..5ced2bc64d59 100644 --- a/docs/generators/scalaz.md +++ b/docs/generators/scalaz.md @@ -1,28 +1,17 @@ -CONFIG OPTIONS for scalaz - - sortParamsByRequiredFlag - Sort method arguments to place required parameters before optional parameters. (Default: true) - - ensureUniqueParams - Whether to ensure parameter names are unique in an operation (rename parameters that are not). (Default: true) - - allowUnicodeIdentifiers - boolean, toggles whether unicode identifiers are allowed in names or not, default is false (Default: false) - - prependFormOrBodyParameters - Add form or body parameters to the beginning of the parameter list. (Default: false) - - modelPackage - package for generated models - - apiPackage - package for generated api classes - - sourceFolder - source folder for generated code - - modelPropertyNaming - Naming convention for the property: 'camelCase', 'PascalCase', 'snake_case' and 'original', which keeps the original name (Default: camelCase) - -Back to the [generators list](README.md) +--- +id: generator-opts-client-scalaz +title: Config Options for scalaz +sidebar_label: scalaz +--- + +| Option | Description | Values | Default | +| ------ | ----------- | ------ | ------- | +|sortParamsByRequiredFlag|Sort method arguments 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| +|prependFormOrBodyParameters|Add form or body parameters to the beginning of the parameter list.| |false| +|modelPackage|package for generated models| |null| +|apiPackage|package for generated api classes| |null| +|sourceFolder|source folder for generated code| |null| +|modelPropertyNaming|Naming convention for the property: 'camelCase', 'PascalCase', 'snake_case' and 'original', which keeps the original name| |camelCase| diff --git a/docs/generators/spring.md b/docs/generators/spring.md index 648064fd8202..f7a3fe37a300 100644 --- a/docs/generators/spring.md +++ b/docs/generators/spring.md @@ -1,182 +1,65 @@ -CONFIG OPTIONS for spring - - sortParamsByRequiredFlag - Sort method arguments to place required parameters before optional parameters. (Default: true) - - ensureUniqueParams - Whether to ensure parameter names are unique in an operation (rename parameters that are not). (Default: true) - - allowUnicodeIdentifiers - boolean, toggles whether unicode identifiers are allowed in names or not, default is false (Default: false) - - prependFormOrBodyParameters - Add form or body parameters to the beginning of the parameter list. (Default: false) - - modelPackage - package for generated models - - apiPackage - package for generated api classes - - invokerPackage - root package for generated code - - groupId - groupId in generated pom.xml - - artifactId - artifactId in generated pom.xml - - artifactVersion - artifact version in generated pom.xml - - artifactUrl - artifact URL in generated pom.xml - - artifactDescription - artifact description in generated pom.xml - - scmConnection - SCM connection in generated pom.xml - - scmDeveloperConnection - SCM developer connection in generated pom.xml - - scmUrl - SCM URL in generated pom.xml - - developerName - developer name in generated pom.xml - - developerEmail - developer email in generated pom.xml - - developerOrganization - developer organization in generated pom.xml - - developerOrganizationUrl - developer organization URL in generated pom.xml - - licenseName - The name of the license - - licenseUrl - The URL of the license - - sourceFolder - source folder for generated code - - localVariablePrefix - prefix for generated code members and local variables - - serializableModel - boolean - toggle "implements Serializable" for generated models (Default: false) - - bigDecimalAsString - Treat BigDecimal values as Strings to avoid precision loss. (Default: false) - - fullJavaUtil - whether to use fully qualified name for classes under java.util. This option only works for Java API client (Default: false) - - hideGenerationTimestamp - hides the timestamp when files were generated - - withXml - whether to include support for application/xml content type and include XML annotations in the model (works with libraries that provide support for JSON and XML) (Default: false) - - dateLibrary - Option. Date library to use - joda - Joda (for legacy app only) - legacy - Legacy java.util.Date (if you really have a good reason not to use threetenbp - java8-localdatetime - Java 8 using LocalDateTime (for legacy app only) - java8 - Java 8 native JSR310 (preferred for jdk 1.8+) - note: this also sets "java8" to true - threetenbp - Backport of JSR310 (preferred for jdk < 1.8) - - java8 - Option. Use Java8 classes instead of third party equivalents - true - Use Java 8 classes such as Base64 - false - Various third party libraries as needed - - disableHtmlEscaping - Disable HTML escaping of JSON strings when using gson (needed to avoid problems with byte[] fields) (Default: false) - - booleanGetterPrefix - Set booleanGetterPrefix (default value 'get') - - parentGroupId - parent groupId in generated pom N.B. parentGroupId, parentArtifactId and parentVersion must all be specified for any of them to take effect - - parentArtifactId - parent artifactId in generated pom N.B. parentGroupId, parentArtifactId and parentVersion must all be specified for any of them to take effect - - parentVersion - parent version in generated pom N.B. parentGroupId, parentArtifactId and parentVersion must all be specified for any of them to take effect - - title - server title name or client service name - - configPackage - configuration package for generated code - - basePackage - base package (invokerPackage) for generated code - - interfaceOnly - Whether to generate only API interface stubs without the server files. (Default: false) - - delegatePattern - Whether to generate the server files using the delegate pattern (Default: false) - - singleContentTypes - Whether to select only one produces/consumes content-type by operation. (Default: false) - - java8 - use java8 default interface (Default: true) - - async - use async Callable controllers (Default: false) - - reactive - wrap responses in Mono/Flux Reactor types (spring-boot only) (Default: false) - - responseWrapper - wrap the responses in given type (Future,Callable,CompletableFuture,ListenableFuture,DeferredResult,HystrixCommand,RxObservable,RxSingle or fully qualified type) - - virtualService - Generates the virtual service. For more details refer - https://github.com/elan-venture/virtualan/wiki (Default: false) - - useTags - use tags for creating interface and controller classnames (Default: false) - - useBeanValidation - Use BeanValidation API annotations (Default: true) - - performBeanValidation - Use Bean Validation Impl. to perform BeanValidation (Default: false) - - implicitHeaders - Use of @ApiImplicitParams for headers. (Default: false) - - swaggerDocketConfig - Generate Spring OpenAPI Docket configuration class. (Default: false) - - apiFirst - Generate the API from the OAI spec at server compile time (API first approach) (Default: false) - - useOptional - Use Optional container for optional parameters (Default: false) - - hateoas - Use Spring HATEOAS library to allow adding HATEOAS links (Default: false) - - returnSuccessCode - Generated server returns 2xx code (Default: false) - - library - library template (sub-template) to use (Default: spring-boot) - spring-boot - Spring-boot Server application using the SpringFox integration. - spring-mvc - Spring-MVC Server application using the SpringFox integration. - spring-cloud - Spring-Cloud-Feign client with Spring-Boot auto-configured settings. - -Back to the [generators list](README.md) +--- +id: generator-opts-server-spring +title: Config Options for spring +sidebar_label: spring +--- + +| Option | Description | Values | Default | +| ------ | ----------- | ------ | ------- | +|sortParamsByRequiredFlag|Sort method arguments 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| +|prependFormOrBodyParameters|Add form or body parameters to the beginning of the parameter list.| |false| +|modelPackage|package for generated models| |null| +|apiPackage|package for generated api classes| |null| +|invokerPackage|root package for generated code| |null| +|groupId|groupId in generated pom.xml| |null| +|artifactId|artifactId in generated pom.xml| |null| +|artifactVersion|artifact version in generated pom.xml| |null| +|artifactUrl|artifact URL in generated pom.xml| |null| +|artifactDescription|artifact description in generated pom.xml| |null| +|scmConnection|SCM connection in generated pom.xml| |null| +|scmDeveloperConnection|SCM developer connection in generated pom.xml| |null| +|scmUrl|SCM URL in generated pom.xml| |null| +|developerName|developer name in generated pom.xml| |null| +|developerEmail|developer email in generated pom.xml| |null| +|developerOrganization|developer organization in generated pom.xml| |null| +|developerOrganizationUrl|developer organization URL in generated pom.xml| |null| +|licenseName|The name of the license| |null| +|licenseUrl|The URL of the license| |null| +|sourceFolder|source folder for generated code| |null| +|localVariablePrefix|prefix for generated code members and local variables| |null| +|serializableModel|boolean - toggle "implements Serializable" for generated models| |false| +|bigDecimalAsString|Treat BigDecimal values as Strings to avoid precision loss.| |false| +|fullJavaUtil|whether to use fully qualified name for classes under java.util. This option only works for Java API client| |false| +|hideGenerationTimestamp|hides the timestamp when files were generated| |null| +|withXml|whether to include support for application/xml content type and include XML annotations in the model (works with libraries that provide support for JSON and XML)| |false| +|dateLibrary|Option. Date library to use|
**joda**
Joda (for legacy app only)
**legacy**
Legacy java.util.Date (if you really have a good reason not to use threetenbp
**java8-localdatetime**
Java 8 using LocalDateTime (for legacy app only)
**java8**
Java 8 native JSR310 (preferred for jdk 1.8+) - note: this also sets "java8" to true
**threetenbp**
Backport of JSR310 (preferred for jdk < 1.8)
|null| +|java8|Option. Use Java8 classes instead of third party equivalents|
**true**
Use Java 8 classes such as Base64
**false**
Various third party libraries as needed
|null| +|disableHtmlEscaping|Disable HTML escaping of JSON strings when using gson (needed to avoid problems with byte[] fields)| |false| +|booleanGetterPrefix|Set booleanGetterPrefix (default value 'get')| |null| +|parentGroupId|parent groupId in generated pom N.B. parentGroupId, parentArtifactId and parentVersion must all be specified for any of them to take effect| |null| +|parentArtifactId|parent artifactId in generated pom N.B. parentGroupId, parentArtifactId and parentVersion must all be specified for any of them to take effect| |null| +|parentVersion|parent version in generated pom N.B. parentGroupId, parentArtifactId and parentVersion must all be specified for any of them to take effect| |null| +|title|server title name or client service name| |null| +|configPackage|configuration package for generated code| |null| +|basePackage|base package (invokerPackage) for generated code| |null| +|interfaceOnly|Whether to generate only API interface stubs without the server files.| |false| +|delegatePattern|Whether to generate the server files using the delegate pattern| |false| +|singleContentTypes|Whether to select only one produces/consumes content-type by operation.| |false| +|java8|use java8 default interface| |true| +|async|use async Callable controllers| |false| +|reactive|wrap responses in Mono/Flux Reactor types (spring-boot only)| |false| +|responseWrapper|wrap the responses in given type (Future,Callable,CompletableFuture,ListenableFuture,DeferredResult,HystrixCommand,RxObservable,RxSingle or fully qualified type)| |null| +|virtualService|Generates the virtual service. For more details refer - https://github.com/elan-venture/virtualan/wiki| |false| +|useTags|use tags for creating interface and controller classnames| |false| +|useBeanValidation|Use BeanValidation API annotations| |true| +|performBeanValidation|Use Bean Validation Impl. to perform BeanValidation| |false| +|implicitHeaders|Use of @ApiImplicitParams for headers.| |false| +|swaggerDocketConfig|Generate Spring OpenAPI Docket configuration class.| |false| +|apiFirst|Generate the API from the OAI spec at server compile time (API first approach)| |false| +|useOptional|Use Optional container for optional parameters| |false| +|hateoas|Use Spring HATEOAS library to allow adding HATEOAS links| |false| +|returnSuccessCode|Generated server returns 2xx code| |false| +|library|library template (sub-template) to use|
**spring-boot**
Spring-boot Server application using the SpringFox integration.
**spring-mvc**
Spring-MVC Server application using the SpringFox integration.
**spring-cloud**
Spring-Cloud-Feign client with Spring-Boot auto-configured settings.
|spring-boot| diff --git a/docs/generators/swift2-deprecated.md b/docs/generators/swift2-deprecated.md index 630a0e1a2e08..51e222c2cd0d 100644 --- a/docs/generators/swift2-deprecated.md +++ b/docs/generators/swift2-deprecated.md @@ -1,64 +1,29 @@ -CONFIG OPTIONS for swift2-deprecated - - sortParamsByRequiredFlag - Sort method arguments to place required parameters before optional parameters. (Default: true) - - ensureUniqueParams - Whether to ensure parameter names are unique in an operation (rename parameters that are not). (Default: true) - - allowUnicodeIdentifiers - boolean, toggles whether unicode identifiers are allowed in names or not, default is false (Default: false) - - prependFormOrBodyParameters - Add form or body parameters to the beginning of the parameter list. (Default: false) - - projectName - Project name in Xcode - - responseAs - Optionally use libraries to manage response. Currently PromiseKit, RxSwift are available. - - unwrapRequired - Treat 'required' properties in response as non-optional (which would crash the app if api returns null as opposed to required option specified in json schema - - podSource - Source information used for Podspec - - podVersion - Version used for Podspec - - podAuthors - Authors used for Podspec - - podSocialMediaURL - Social Media URL used for Podspec - - podDocsetURL - Docset URL used for Podspec - - podLicense - License used for Podspec - - podHomepage - Homepage used for Podspec - - podSummary - Summary used for Podspec - - podDescription - Description used for Podspec - - podScreenshots - Screenshots used for Podspec - - podDocumentationURL - Documentation URL used for Podspec - - swiftUseApiNamespace - Flag to make all the API classes inner-class of {{projectName}}API - - hideGenerationTimestamp - Hides the generation timestamp when files are generated. (Default: true) - -Back to the [generators list](README.md) +--- +id: generator-opts-client-swift2-deprecated +title: Config Options for swift2-deprecated +sidebar_label: swift2-deprecated +--- + +| Option | Description | Values | Default | +| ------ | ----------- | ------ | ------- | +|sortParamsByRequiredFlag|Sort method arguments 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| +|prependFormOrBodyParameters|Add form or body parameters to the beginning of the parameter list.| |false| +|projectName|Project name in Xcode| |null| +|responseAs|Optionally use libraries to manage response. Currently PromiseKit, RxSwift are available.| |null| +|unwrapRequired|Treat 'required' properties in response as non-optional (which would crash the app if api returns null as opposed to required option specified in json schema| |null| +|podSource|Source information used for Podspec| |null| +|podVersion|Version used for Podspec| |null| +|podAuthors|Authors used for Podspec| |null| +|podSocialMediaURL|Social Media URL used for Podspec| |null| +|podDocsetURL|Docset URL used for Podspec| |null| +|podLicense|License used for Podspec| |null| +|podHomepage|Homepage used for Podspec| |null| +|podSummary|Summary used for Podspec| |null| +|podDescription|Description used for Podspec| |null| +|podScreenshots|Screenshots used for Podspec| |null| +|podDocumentationURL|Documentation URL used for Podspec| |null| +|swiftUseApiNamespace|Flag to make all the API classes inner-class of {{projectName}}API| |null| +|hideGenerationTimestamp|Hides the generation timestamp when files are generated.| |true| diff --git a/docs/generators/swift3-deprecated.md b/docs/generators/swift3-deprecated.md new file mode 100644 index 000000000000..1041bf635945 --- /dev/null +++ b/docs/generators/swift3-deprecated.md @@ -0,0 +1,31 @@ + +--- +id: generator-opts-client-swift3-deprecated +title: Config Options for swift3-deprecated +sidebar_label: swift3-deprecated +--- + +| Option | Description | Values | Default | +| ------ | ----------- | ------ | ------- | +|sortParamsByRequiredFlag|Sort method arguments 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| +|prependFormOrBodyParameters|Add form or body parameters to the beginning of the parameter list.| |false| +|projectName|Project name in Xcode| |null| +|responseAs|Optionally use libraries to manage response. Currently PromiseKit, RxSwift are available.| |null| +|unwrapRequired|Treat 'required' properties in response as non-optional (which would crash the app if api returns null as opposed to required option specified in json schema| |null| +|objcCompatible|Add additional properties and methods for Objective-C compatibility (default: false)| |null| +|podSource|Source information used for Podspec| |null| +|podVersion|Version used for Podspec| |null| +|podAuthors|Authors used for Podspec| |null| +|podSocialMediaURL|Social Media URL used for Podspec| |null| +|podDocsetURL|Docset URL used for Podspec| |null| +|podLicense|License used for Podspec| |null| +|podHomepage|Homepage used for Podspec| |null| +|podSummary|Summary used for Podspec| |null| +|podDescription|Description used for Podspec| |null| +|podScreenshots|Screenshots used for Podspec| |null| +|podDocumentationURL|Documentation URL used for Podspec| |null| +|swiftUseApiNamespace|Flag to make all the API classes inner-class of {{projectName}}API| |null| +|hideGenerationTimestamp|Hides the generation timestamp when files are generated.| |true| +|lenientTypeCast|Accept and cast values for simple types (string->bool, string->int, int->string)| |false| diff --git a/docs/generators/swift3.md b/docs/generators/swift3.md deleted file mode 100644 index 42674fdb2626..000000000000 --- a/docs/generators/swift3.md +++ /dev/null @@ -1,70 +0,0 @@ - -CONFIG OPTIONS for swift3 - - sortParamsByRequiredFlag - Sort method arguments to place required parameters before optional parameters. (Default: true) - - ensureUniqueParams - Whether to ensure parameter names are unique in an operation (rename parameters that are not). (Default: true) - - allowUnicodeIdentifiers - boolean, toggles whether unicode identifiers are allowed in names or not, default is false (Default: false) - - prependFormOrBodyParameters - Add form or body parameters to the beginning of the parameter list. (Default: false) - - projectName - Project name in Xcode - - responseAs - Optionally use libraries to manage response. Currently PromiseKit, RxSwift are available. - - unwrapRequired - Treat 'required' properties in response as non-optional (which would crash the app if api returns null as opposed to required option specified in json schema - - objcCompatible - Add additional properties and methods for Objective-C compatibility (default: false) - - podSource - Source information used for Podspec - - podVersion - Version used for Podspec - - podAuthors - Authors used for Podspec - - podSocialMediaURL - Social Media URL used for Podspec - - podDocsetURL - Docset URL used for Podspec - - podLicense - License used for Podspec - - podHomepage - Homepage used for Podspec - - podSummary - Summary used for Podspec - - podDescription - Description used for Podspec - - podScreenshots - Screenshots used for Podspec - - podDocumentationURL - Documentation URL used for Podspec - - swiftUseApiNamespace - Flag to make all the API classes inner-class of {{projectName}}API - - hideGenerationTimestamp - Hides the generation timestamp when files are generated. (Default: true) - - lenientTypeCast - Accept and cast values for simple types (string->bool, string->int, int->string) (Default: false) - -Back to the [generators list](README.md) diff --git a/docs/generators/swift4.md b/docs/generators/swift4.md index 6e824970759c..f1035b6db24e 100644 --- a/docs/generators/swift4.md +++ b/docs/generators/swift4.md @@ -1,70 +1,31 @@ -CONFIG OPTIONS for swift4 - - sortParamsByRequiredFlag - Sort method arguments to place required parameters before optional parameters. (Default: true) - - ensureUniqueParams - Whether to ensure parameter names are unique in an operation (rename parameters that are not). (Default: true) - - allowUnicodeIdentifiers - boolean, toggles whether unicode identifiers are allowed in names or not, default is false (Default: false) - - prependFormOrBodyParameters - Add form or body parameters to the beginning of the parameter list. (Default: false) - - projectName - Project name in Xcode - - responseAs - Optionally use libraries to manage response. Currently PromiseKit, RxSwift are available. - - unwrapRequired - Treat 'required' properties in response as non-optional (which would crash the app if api returns null as opposed to required option specified in json schema - - objcCompatible - Add additional properties and methods for Objective-C compatibility (default: false) - - podSource - Source information used for Podspec - - podVersion - Version used for Podspec - - podAuthors - Authors used for Podspec - - podSocialMediaURL - Social Media URL used for Podspec - - podDocsetURL - Docset URL used for Podspec - - podLicense - License used for Podspec - - podHomepage - Homepage used for Podspec - - podSummary - Summary used for Podspec - - podDescription - Description used for Podspec - - podScreenshots - Screenshots used for Podspec - - podDocumentationURL - Documentation URL used for Podspec - - swiftUseApiNamespace - Flag to make all the API classes inner-class of {{projectName}}API - - hideGenerationTimestamp - Hides the generation timestamp when files are generated. (Default: true) - - lenientTypeCast - Accept and cast values for simple types (string->bool, string->int, int->string) (Default: false) - -Back to the [generators list](README.md) +--- +id: generator-opts-client-swift4 +title: Config Options for swift4 +sidebar_label: swift4 +--- + +| Option | Description | Values | Default | +| ------ | ----------- | ------ | ------- | +|sortParamsByRequiredFlag|Sort method arguments 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| +|prependFormOrBodyParameters|Add form or body parameters to the beginning of the parameter list.| |false| +|projectName|Project name in Xcode| |null| +|responseAs|Optionally use libraries to manage response. Currently PromiseKit, RxSwift are available.| |null| +|unwrapRequired|Treat 'required' properties in response as non-optional (which would crash the app if api returns null as opposed to required option specified in json schema| |null| +|objcCompatible|Add additional properties and methods for Objective-C compatibility (default: false)| |null| +|podSource|Source information used for Podspec| |null| +|podVersion|Version used for Podspec| |null| +|podAuthors|Authors used for Podspec| |null| +|podSocialMediaURL|Social Media URL used for Podspec| |null| +|podDocsetURL|Docset URL used for Podspec| |null| +|podLicense|License used for Podspec| |null| +|podHomepage|Homepage used for Podspec| |null| +|podSummary|Summary used for Podspec| |null| +|podDescription|Description used for Podspec| |null| +|podScreenshots|Screenshots used for Podspec| |null| +|podDocumentationURL|Documentation URL used for Podspec| |null| +|swiftUseApiNamespace|Flag to make all the API classes inner-class of {{projectName}}API| |null| +|hideGenerationTimestamp|Hides the generation timestamp when files are generated.| |true| +|lenientTypeCast|Accept and cast values for simple types (string->bool, string->int, int->string)| |false| diff --git a/docs/generators/typescript-angular.md b/docs/generators/typescript-angular.md index e459084760d2..c3f561752f89 100644 --- a/docs/generators/typescript-angular.md +++ b/docs/generators/typescript-angular.md @@ -1,61 +1,28 @@ -CONFIG OPTIONS for typescript-angular - - sortParamsByRequiredFlag - Sort method arguments to place required parameters before optional parameters. (Default: true) - - ensureUniqueParams - Whether to ensure parameter names are unique in an operation (rename parameters that are not). (Default: true) - - allowUnicodeIdentifiers - boolean, toggles whether unicode identifiers are allowed in names or not, default is false (Default: false) - - prependFormOrBodyParameters - Add form or body parameters to the beginning of the parameter list. (Default: false) - - modelPropertyNaming - Naming convention for the property: 'camelCase', 'PascalCase', 'snake_case' and 'original', which keeps the original name (Default: camelCase) - - supportsES6 - Generate code that conforms to ES6. (Default: false) - - npmName - The name under which you want to publish generated npm package. Required to generate a full angular package - - npmVersion - The version of your npm package. Default is '1.0.0' - - npmRepository - Use this property to set an url your private npmRepo in the package.json - - snapshot - When setting this property to true the version will be suffixed with -SNAPSHOT.yyyyMMddHHmm (Default: false) - - withInterfaces - Setting this property to true will generate interfaces next to the default class implementations. (Default: false) - - taggedUnions - Use discriminators to create tagged unions instead of extending interfaces. (Default: false) - - providedInRoot - Use this property to provide Injectables in root (it is only valid in angular version greater or equal to 6.0.0). (Default: false) - - ngVersion - The version of Angular. Default is '4.3' - - serviceSuffix - The suffix of the generated service. Default is 'Service'. - - serviceFileSuffix - The suffix of the file of the generated service (service.ts). Default is '.service'. - - modelSuffix - The suffix of the generated model. Default is ''. - - modelFileSuffix - The suffix of the file of the generated model (model.ts). Default is ''. - - fileNaming - Naming convention for the output files: 'camelCase', 'kebab-case'. Default is 'camelCase'. - -Back to the [generators list](README.md) +--- +id: generator-opts-client-typescript-angular +title: Config Options for typescript-angular +sidebar_label: typescript-angular +--- + +| Option | Description | Values | Default | +| ------ | ----------- | ------ | ------- | +|sortParamsByRequiredFlag|Sort method arguments 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| +|prependFormOrBodyParameters|Add form or body parameters to the beginning of the parameter list.| |false| +|modelPropertyNaming|Naming convention for the property: 'camelCase', 'PascalCase', 'snake_case' and 'original', which keeps the original name| |camelCase| +|supportsES6|Generate code that conforms to ES6.| |false| +|npmName|The name under which you want to publish generated npm package. Required to generate a full angular package| |null| +|npmVersion|The version of your npm package. Default is '1.0.0'| |null| +|npmRepository|Use this property to set an url your private npmRepo in the package.json| |null| +|snapshot|When setting this property to true the version will be suffixed with -SNAPSHOT.yyyyMMddHHmm| |false| +|withInterfaces|Setting this property to true will generate interfaces next to the default class implementations.| |false| +|taggedUnions|Use discriminators to create tagged unions instead of extending interfaces.| |false| +|providedInRoot|Use this property to provide Injectables in root (it is only valid in angular version greater or equal to 6.0.0).| |false| +|ngVersion|The version of Angular. Default is '4.3'| |null| +|serviceSuffix|The suffix of the generated service. Default is 'Service'.| |null| +|serviceFileSuffix|The suffix of the file of the generated service (service<suffix>.ts). Default is '.service'.| |null| +|modelSuffix|The suffix of the generated model. Default is ''.| |null| +|modelFileSuffix|The suffix of the file of the generated model (model<suffix>.ts). Default is ''.| |null| +|fileNaming|Naming convention for the output files: 'camelCase', 'kebab-case'. Default is 'camelCase'.| |null| diff --git a/docs/generators/typescript-angularjs.md b/docs/generators/typescript-angularjs.md index 7f8fd7720c0d..da03265443dc 100644 --- a/docs/generators/typescript-angularjs.md +++ b/docs/generators/typescript-angularjs.md @@ -1,22 +1,15 @@ -CONFIG OPTIONS for typescript-angularjs - - sortParamsByRequiredFlag - Sort method arguments to place required parameters before optional parameters. (Default: true) - - ensureUniqueParams - Whether to ensure parameter names are unique in an operation (rename parameters that are not). (Default: true) - - allowUnicodeIdentifiers - boolean, toggles whether unicode identifiers are allowed in names or not, default is false (Default: false) - - prependFormOrBodyParameters - Add form or body parameters to the beginning of the parameter list. (Default: false) - - modelPropertyNaming - Naming convention for the property: 'camelCase', 'PascalCase', 'snake_case' and 'original', which keeps the original name (Default: camelCase) - - supportsES6 - Generate code that conforms to ES6. (Default: false) - -Back to the [generators list](README.md) +--- +id: generator-opts-client-typescript-angularjs +title: Config Options for typescript-angularjs +sidebar_label: typescript-angularjs +--- + +| Option | Description | Values | Default | +| ------ | ----------- | ------ | ------- | +|sortParamsByRequiredFlag|Sort method arguments 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| +|prependFormOrBodyParameters|Add form or body parameters to the beginning of the parameter list.| |false| +|modelPropertyNaming|Naming convention for the property: 'camelCase', 'PascalCase', 'snake_case' and 'original', which keeps the original name| |camelCase| +|supportsES6|Generate code that conforms to ES6.| |false| diff --git a/docs/generators/typescript-aurelia.md b/docs/generators/typescript-aurelia.md index dd9c7f14e2f0..1313df5d5eef 100644 --- a/docs/generators/typescript-aurelia.md +++ b/docs/generators/typescript-aurelia.md @@ -1,28 +1,17 @@ -CONFIG OPTIONS for typescript-aurelia - - sortParamsByRequiredFlag - Sort method arguments to place required parameters before optional parameters. (Default: true) - - ensureUniqueParams - Whether to ensure parameter names are unique in an operation (rename parameters that are not). (Default: true) - - allowUnicodeIdentifiers - boolean, toggles whether unicode identifiers are allowed in names or not, default is false (Default: false) - - prependFormOrBodyParameters - Add form or body parameters to the beginning of the parameter list. (Default: false) - - modelPropertyNaming - Naming convention for the property: 'camelCase', 'PascalCase', 'snake_case' and 'original', which keeps the original name (Default: camelCase) - - supportsES6 - Generate code that conforms to ES6. (Default: false) - - npmName - The name under which you want to publish generated npm package - - npmVersion - The version of your npm package - -Back to the [generators list](README.md) +--- +id: generator-opts-client-typescript-aurelia +title: Config Options for typescript-aurelia +sidebar_label: typescript-aurelia +--- + +| Option | Description | Values | Default | +| ------ | ----------- | ------ | ------- | +|sortParamsByRequiredFlag|Sort method arguments 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| +|prependFormOrBodyParameters|Add form or body parameters to the beginning of the parameter list.| |false| +|modelPropertyNaming|Naming convention for the property: 'camelCase', 'PascalCase', 'snake_case' and 'original', which keeps the original name| |camelCase| +|supportsES6|Generate code that conforms to ES6.| |false| +|npmName|The name under which you want to publish generated npm package| |null| +|npmVersion|The version of your npm package| |null| diff --git a/docs/generators/typescript-axios.md b/docs/generators/typescript-axios.md index 654858710c45..29ff5edec1a9 100644 --- a/docs/generators/typescript-axios.md +++ b/docs/generators/typescript-axios.md @@ -1,37 +1,20 @@ -CONFIG OPTIONS for typescript-axios - - sortParamsByRequiredFlag - Sort method arguments to place required parameters before optional parameters. (Default: true) - - ensureUniqueParams - Whether to ensure parameter names are unique in an operation (rename parameters that are not). (Default: true) - - allowUnicodeIdentifiers - boolean, toggles whether unicode identifiers are allowed in names or not, default is false (Default: false) - - prependFormOrBodyParameters - Add form or body parameters to the beginning of the parameter list. (Default: false) - - modelPropertyNaming - Naming convention for the property: 'camelCase', 'PascalCase', 'snake_case' and 'original', which keeps the original name (Default: camelCase) - - supportsES6 - Generate code that conforms to ES6. (Default: false) - - npmName - The name under which you want to publish generated npm package - - npmVersion - The version of your npm package - - npmRepository - Use this property to set an url your private npmRepo in the package.json - - snapshot - When setting this property to true the version will be suffixed with -SNAPSHOT.yyyyMMddHHmm (Default: false) - - withInterfaces - Setting this property to true will generate interfaces next to the default class implementations. (Default: false) - -Back to the [generators list](README.md) +--- +id: generator-opts-client-typescript-axios +title: Config Options for typescript-axios +sidebar_label: typescript-axios +--- + +| Option | Description | Values | Default | +| ------ | ----------- | ------ | ------- | +|sortParamsByRequiredFlag|Sort method arguments 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| +|prependFormOrBodyParameters|Add form or body parameters to the beginning of the parameter list.| |false| +|modelPropertyNaming|Naming convention for the property: 'camelCase', 'PascalCase', 'snake_case' and 'original', which keeps the original name| |camelCase| +|supportsES6|Generate code that conforms to ES6.| |false| +|npmName|The name under which you want to publish generated npm package| |null| +|npmVersion|The version of your npm package| |null| +|npmRepository|Use this property to set an url your private npmRepo in the package.json| |null| +|snapshot|When setting this property to true the version will be suffixed with -SNAPSHOT.yyyyMMddHHmm| |false| +|withInterfaces|Setting this property to true will generate interfaces next to the default class implementations.| |false| diff --git a/docs/generators/typescript-fetch.md b/docs/generators/typescript-fetch.md index 97633d03ebfe..71742b582f98 100644 --- a/docs/generators/typescript-fetch.md +++ b/docs/generators/typescript-fetch.md @@ -1,37 +1,20 @@ -CONFIG OPTIONS for typescript-fetch - - sortParamsByRequiredFlag - Sort method arguments to place required parameters before optional parameters. (Default: true) - - ensureUniqueParams - Whether to ensure parameter names are unique in an operation (rename parameters that are not). (Default: true) - - allowUnicodeIdentifiers - boolean, toggles whether unicode identifiers are allowed in names or not, default is false (Default: false) - - prependFormOrBodyParameters - Add form or body parameters to the beginning of the parameter list. (Default: false) - - modelPropertyNaming - Naming convention for the property: 'camelCase', 'PascalCase', 'snake_case' and 'original', which keeps the original name (Default: camelCase) - - supportsES6 - Generate code that conforms to ES6. (Default: false) - - npmName - The name under which you want to publish generated npm package - - npmVersion - The version of your npm package - - npmRepository - Use this property to set an url your private npmRepo in the package.json - - snapshot - When setting this property to true the version will be suffixed with -SNAPSHOT.yyyyMMddHHmm (Default: false) - - withInterfaces - Setting this property to true will generate interfaces next to the default class implementations. (Default: false) - -Back to the [generators list](README.md) +--- +id: generator-opts-client-typescript-fetch +title: Config Options for typescript-fetch +sidebar_label: typescript-fetch +--- + +| Option | Description | Values | Default | +| ------ | ----------- | ------ | ------- | +|sortParamsByRequiredFlag|Sort method arguments 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| +|prependFormOrBodyParameters|Add form or body parameters to the beginning of the parameter list.| |false| +|modelPropertyNaming|Naming convention for the property: 'camelCase', 'PascalCase', 'snake_case' and 'original', which keeps the original name| |camelCase| +|supportsES6|Generate code that conforms to ES6.| |false| +|npmName|The name under which you want to publish generated npm package| |null| +|npmVersion|The version of your npm package| |null| +|npmRepository|Use this property to set an url your private npmRepo in the package.json| |null| +|snapshot|When setting this property to true the version will be suffixed with -SNAPSHOT.yyyyMMddHHmm| |false| +|withInterfaces|Setting this property to true will generate interfaces next to the default class implementations.| |false| diff --git a/docs/generators/typescript-inversify.md b/docs/generators/typescript-inversify.md index 9354cd8b4a69..c521c73f4b79 100644 --- a/docs/generators/typescript-inversify.md +++ b/docs/generators/typescript-inversify.md @@ -1,43 +1,22 @@ -CONFIG OPTIONS for typescript-inversify - - sortParamsByRequiredFlag - Sort method arguments to place required parameters before optional parameters. (Default: true) - - ensureUniqueParams - Whether to ensure parameter names are unique in an operation (rename parameters that are not). (Default: true) - - allowUnicodeIdentifiers - boolean, toggles whether unicode identifiers are allowed in names or not, default is false (Default: false) - - prependFormOrBodyParameters - Add form or body parameters to the beginning of the parameter list. (Default: false) - - modelPropertyNaming - Naming convention for the property: 'camelCase', 'PascalCase', 'snake_case' and 'original', which keeps the original name (Default: camelCase) - - supportsES6 - Generate code that conforms to ES6. (Default: false) - - npmName - The name under which you want to publish generated npm package - - npmVersion - The version of your npm package - - npmRepository - Use this property to set an url your private npmRepo in the package.json - - snapshot - When setting this property to true the version will be suffixed with -SNAPSHOT.yyyyMMddHHmm (Default: false) - - withInterfaces - Setting this property to true will generate interfaces next to the default class implementations. (Default: false) - - usePromise - Setting this property to use promise instead of observable inside every service. (Default: false) - - taggedUnions - Use discriminators to create tagged unions instead of extending interfaces. (Default: false) - -Back to the [generators list](README.md) +--- +id: generator-opts-client-typescript-inversify +title: Config Options for typescript-inversify +sidebar_label: typescript-inversify +--- + +| Option | Description | Values | Default | +| ------ | ----------- | ------ | ------- | +|sortParamsByRequiredFlag|Sort method arguments 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| +|prependFormOrBodyParameters|Add form or body parameters to the beginning of the parameter list.| |false| +|modelPropertyNaming|Naming convention for the property: 'camelCase', 'PascalCase', 'snake_case' and 'original', which keeps the original name| |camelCase| +|supportsES6|Generate code that conforms to ES6.| |false| +|npmName|The name under which you want to publish generated npm package| |null| +|npmVersion|The version of your npm package| |null| +|npmRepository|Use this property to set an url your private npmRepo in the package.json| |null| +|snapshot|When setting this property to true the version will be suffixed with -SNAPSHOT.yyyyMMddHHmm| |false| +|withInterfaces|Setting this property to true will generate interfaces next to the default class implementations.| |false| +|usePromise|Setting this property to use promise instead of observable inside every service.| |false| +|taggedUnions|Use discriminators to create tagged unions instead of extending interfaces.| |false| diff --git a/docs/generators/typescript-jquery.md b/docs/generators/typescript-jquery.md index eeef27289c06..b40fd66c3b26 100644 --- a/docs/generators/typescript-jquery.md +++ b/docs/generators/typescript-jquery.md @@ -1,37 +1,20 @@ -CONFIG OPTIONS for typescript-jquery - - sortParamsByRequiredFlag - Sort method arguments to place required parameters before optional parameters. (Default: true) - - ensureUniqueParams - Whether to ensure parameter names are unique in an operation (rename parameters that are not). (Default: true) - - allowUnicodeIdentifiers - boolean, toggles whether unicode identifiers are allowed in names or not, default is false (Default: false) - - prependFormOrBodyParameters - Add form or body parameters to the beginning of the parameter list. (Default: false) - - modelPropertyNaming - Naming convention for the property: 'camelCase', 'PascalCase', 'snake_case' and 'original', which keeps the original name (Default: camelCase) - - supportsES6 - Generate code that conforms to ES6. (Default: false) - - npmName - The name under which you want to publish generated npm package - - npmVersion - The version of your npm package - - npmRepository - Use this property to set an url your private npmRepo in the package.json - - snapshot - When setting this property to true the version will be suffixed with -SNAPSHOT.yyyyMMddHHmm (Default: false) - - jqueryAlreadyImported - When using this in legacy app using mix of typescript and javascript, this will only declare jquery and not import it (Default: false) - -Back to the [generators list](README.md) +--- +id: generator-opts-client-typescript-jquery +title: Config Options for typescript-jquery +sidebar_label: typescript-jquery +--- + +| Option | Description | Values | Default | +| ------ | ----------- | ------ | ------- | +|sortParamsByRequiredFlag|Sort method arguments 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| +|prependFormOrBodyParameters|Add form or body parameters to the beginning of the parameter list.| |false| +|modelPropertyNaming|Naming convention for the property: 'camelCase', 'PascalCase', 'snake_case' and 'original', which keeps the original name| |camelCase| +|supportsES6|Generate code that conforms to ES6.| |false| +|npmName|The name under which you want to publish generated npm package| |null| +|npmVersion|The version of your npm package| |null| +|npmRepository|Use this property to set an url your private npmRepo in the package.json| |null| +|snapshot|When setting this property to true the version will be suffixed with -SNAPSHOT.yyyyMMddHHmm| |false| +|jqueryAlreadyImported|When using this in legacy app using mix of typescript and javascript, this will only declare jquery and not import it| |false| diff --git a/docs/generators/typescript-node.md b/docs/generators/typescript-node.md index 008dae08c092..76fb2925277e 100644 --- a/docs/generators/typescript-node.md +++ b/docs/generators/typescript-node.md @@ -1,34 +1,19 @@ -CONFIG OPTIONS for typescript-node - - sortParamsByRequiredFlag - Sort method arguments to place required parameters before optional parameters. (Default: true) - - ensureUniqueParams - Whether to ensure parameter names are unique in an operation (rename parameters that are not). (Default: true) - - allowUnicodeIdentifiers - boolean, toggles whether unicode identifiers are allowed in names or not, default is false (Default: false) - - prependFormOrBodyParameters - Add form or body parameters to the beginning of the parameter list. (Default: false) - - modelPropertyNaming - Naming convention for the property: 'camelCase', 'PascalCase', 'snake_case' and 'original', which keeps the original name (Default: camelCase) - - supportsES6 - Generate code that conforms to ES6. (Default: false) - - npmName - The name under which you want to publish generated npm package - - npmVersion - The version of your npm package - - npmRepository - Use this property to set an url your private npmRepo in the package.json - - snapshot - When setting this property to true the version will be suffixed with -SNAPSHOT.yyyyMMddHHmm (Default: false) - -Back to the [generators list](README.md) +--- +id: generator-opts-client-typescript-node +title: Config Options for typescript-node +sidebar_label: typescript-node +--- + +| Option | Description | Values | Default | +| ------ | ----------- | ------ | ------- | +|sortParamsByRequiredFlag|Sort method arguments 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| +|prependFormOrBodyParameters|Add form or body parameters to the beginning of the parameter list.| |false| +|modelPropertyNaming|Naming convention for the property: 'camelCase', 'PascalCase', 'snake_case' and 'original', which keeps the original name| |camelCase| +|supportsES6|Generate code that conforms to ES6.| |false| +|npmName|The name under which you want to publish generated npm package| |null| +|npmVersion|The version of your npm package| |null| +|npmRepository|Use this property to set an url your private npmRepo in the package.json| |null| +|snapshot|When setting this property to true the version will be suffixed with -SNAPSHOT.yyyyMMddHHmm| |false| diff --git a/docs/integration.md b/docs/integration.md index 99c76b25f928..0ab59c547b4b 100644 --- a/docs/integration.md +++ b/docs/integration.md @@ -1,8 +1,12 @@ +--- +id: integrations +title: Workflow Integrations +--- ## Workflow Integration (Maven, Github, CI/CD) ### Gradle Integration -See the [openapi-generator-gradle-plugin README](../modules/openapi-generator-gradle-plugin/README.adoc) for details related to configuring and using the Gradle Plugin. +See the [openapi-generator-gradle-plugin README](https://github.com/OpenAPITools/openapi-generator/blob/master/modules/openapi-generator-gradle-plugin/README.adoc) for details related to configuring and using the Gradle Plugin. Supported tasks include: @@ -13,7 +17,7 @@ Supported tasks include: ### Maven Integration -See the [openapi-generator-maven-plugin README](../modules/openapi-generator-maven-plugin/README.md) for details related to configuring and using the Maven Plugin. +See the [openapi-generator-maven-plugin README](https://github.com/OpenAPITools/openapi-generator/blob/master/modules/openapi-generator-maven-plugin/README.md) for details related to configuring and using the Maven Plugin. ### GitHub Integration @@ -40,5 +44,3 @@ cd /var/tmp/perl/petstore Some generators also generate CI/CD configuration files (.travis.yml) so that the output will be ready to be tested by the CI (e.g. Travis) If you're looking for the configuration files of a particular CI that is not yet supported, please open an [issue](https://github.com/openapitools/openapi-generator/issues/new) to let us know. - -[Back to OpenAPI-Generator's README page](../README.md) diff --git a/docs/migration-from-swagger-codegen.md b/docs/migration-from-swagger-codegen.md index d40976c9667d..6bea0095b659 100644 --- a/docs/migration-from-swagger-codegen.md +++ b/docs/migration-from-swagger-codegen.md @@ -1,4 +1,7 @@ -## Migration guide: from Swagger Codegen to OpenAPI Generator +--- +id: swagger-codegen-migration +title: Migrating from Swagger Codegen +--- OpenAPI Generator is a fork of `swagger-codegen` between version `2.3.1` and `2.4.0`. This community-driven version called "OpenAPI Generator" provides similar functionalities and can be used as drop-in replacement. @@ -20,7 +23,7 @@ This guide explains the major differences in order to help you with the migratio - [Body parameter name](#body-parameter-name) - [Generators not yet fully migrated](#generators-not-yet-fully-migrated) -### New docker images +## New docker images The docker images are available on DockerHub: https://hub.docker.com/u/openapitools/ @@ -41,7 +44,7 @@ Old: `swaggerapi/swagger-generator` New: `openapitools/openapi-generator-online` -### New maven coordinates +## New maven coordinates You can find our released artefact on maven central: @@ -101,14 +104,14 @@ New: ``` -### Changes in Maven Plugin +## Changes in Maven Plugin OpenAPI Generator 3.0.0 has introduced `` and deprecated ``, because this refers to generator names which embed more than just "language". If both options are present, you'll be presented with an error. If only `` is provided, you'll be presented instructions for updating to the new config. -### New generators names +## New generators names When you run OpenAPI Generator, you need to select a target generator (`-g` option in the cli). All languages of `swagger-codegen` have been migrated to `openapi-generator`, but some names were changed, in order to be more consistent. @@ -130,7 +133,7 @@ All languages of `swagger-codegen` have been migrated to `openapi-generator`, bu We provide a temporary mapping in code for these old values. You'll receive a warning with instructions to migrate to the new names. -### New parameters name +## New parameters name Some parameters were renamed. Often you need to replace "Swagger", with "OpenAPI". @@ -144,14 +147,14 @@ Some examples: | `swagger.codegen.undertow.modelpackage` | `openapi.codegen.undertow.modelpackage` | -### Renamed Mustache Template Variables +## Renamed Mustache Template Variables The template variable `{{datatype}}` was renamed to `{{dataType}}` for consistency reason. Corresponding java code: `CodegenProperty.datatype` is renamed to `CodegenProperty.dataType`. (If you're **not** using customized templates with the `-t` option, you can ignore the mustache variable renaming above.) -### Ignore file +## Ignore file `.swagger-codegen-ignore` is replaced by `.openapi-generator-ignore`. The syntax inside the file stays the same. @@ -160,13 +163,13 @@ You don't need to rename the file manually, OpenAPI Generator will do it when yo (When there is no `.openapi-generator-ignore` in a folder, if a `.swagger-codegen-ignore` file is present it will be considered and renamed to `.openapi-generator-ignore`). -### Metadata folder +## Metadata folder The metatata folder (to store the `VERSION` file for example) is now called `.openapi-generator/` instead of `.swagger-codegen/`. -### New default values for the generated code +## New default values for the generated code If you use a generator without specifying each parameter, you might see some differences in the generated code. As example the default package name used in the generated code has changed. @@ -176,13 +179,13 @@ Concretely if you did not specify anything when you are generating java code, a If this is a problem for you, you need to explicitly set the the parameter value in order to match with the `swagger-codgen` default value (`apiPackage` == `io.swagger` in the previous example with the java generator). -### New fully qualified name for the classes +## New fully qualified name for the classes If you have extended some generators in your project, and you are looking for a specific class, replace the `io.swagger.codegen` package (old name) with `org.openapitools.codegen` package (new name). Example: `org.openapitools.codegen.DefaultGenerator` -### Body parameter name +## Body parameter name In OpenAPI spec v3, there's no body parameter, which is replaced by [Request Body Object](https://github.com/OAI/OpenAPI-Specification/blob/master/versions/3.0.1.md#request-body-object). The parameter name for Request Body is named automatically based on the model name (e.g. User). To control how the "Request Body" parmaeter is named, please add the vendor extension `x-codegen-request-body-name` to the operation: @@ -241,16 +244,3 @@ paths: - 'read:pets' ``` If your API client is using named parameters in the function call (e.g. Perl required & optional parameters, Ruby optional parameters), you will need to add `x-codegen-request-body-name` to the spec to restore the original body parameter name. - -# Generators not yet fully migrated - -The following gnereators are not yet fully migrated and tested - -- ~~rust-server~~ (migrated) -- ~~`apex`~~ (migrated) - -and we welcome contributions from the community to help with the migration. - -UPDATE: all generators have been successfullly migrated. - -[Back to OpenAPI-Generator's README page](../README.md) diff --git a/docs/online-openapi-generator.md b/docs/online-openapi-generator.md index f41b6419a1a2..4b981bf32dbb 100644 --- a/docs/online-openapi-generator.md +++ b/docs/online-openapi-generator.md @@ -1,4 +1,7 @@ -## Online OpenAPI generator +--- +id: openapi-generator-online +title: Online OpenAPI Generator +--- One can also generate API clients or server stubs using the online openapi-generator. @@ -85,4 +88,4 @@ Instead of using `openAPIUrl` with an URL to the OpenAPI spec, one can include t ... } } -``` +``` \ No newline at end of file diff --git a/docs/qna.md b/docs/qna.md index d8681f8cde2c..7c3d732ca64c 100644 --- a/docs/qna.md +++ b/docs/qna.md @@ -1,41 +1,27 @@ -## Question and Answer +--- +id: fork-qna +title: Swagger Codegen Fork: Q&A +--- -#### What is the governance structure of the OpenAPI Generator project? +This document aims to answer some questions about the fork for historical reference, where these questions don't fit into other documents related to the project itself. -OpenAPI generator (openapi-generator) is managed by the members of the [core team](../README.md#openapi-generator-core-team). - - -#### What is the difference between Swagger Codegen and OpenAPI Generator? - -Swagger Codegen is driven by SmartBear while OpenAPI Generator is driven by the community. More than 40 top contributors and template creators of Swagger Codegen have joined OpenAPI Generator as the founding team members. - -Swagger is a trademark owned by SmartBear and the use of the term "Swagger" in this project is for demo (reference) purposes only. - - -#### Why was it decided to fork Swagger Codegen and to maintain a community-driven version? +## Why was it decided to fork Swagger Codegen? There are several reasons: -1. The founding members came to the conclusion that Swagger Codegen 3.0.0 beta contains too many breaking changes. They also strongly believe the 3.0.0 release should only focus on one thing: OpenAPI 3.0 support. -1. The founding members had concerns about the development practices, which seemed to be contributing to an unstable and insufficiently tested codebase. -1. There was a disagreement on the evolutionary strategy for Swagger Codegen. The founding members felt it was important to move forward with OpenAPI 3.0 support, while maintaining backward compatibility with OpenAPI 2.0 in the same codebase. -1. The founding members found that the enhancements and bug fixes submitted for Swagger Codegen 2.x need to be submitted again for Swagger Codegen 3.0.0 branch (otherwise, these changes would not appear in the 3.0.0 branch. Having to do the pull request twice is not the best use of community resources). -1. The community-driven version has a more rapid [release cycle](https://github.com/OpenAPITools/openapi-generator/releases/) (weekly patch release, monthly minor release) so users do not need to wait for several months to get a stable release. -1. Having a community-driven version _can_ bring the project to the next level with reliable releases and a clear [roadmap](https://github.com/OpenAPITools/openapi-generator/blob/master/docs/roadmap.adoc). - -#### Was anything done to attempt to address the issues before deciding to fork Swagger Codegen and maintain a community-driven version? - -There were several conversations with the project owners of Swagger Codegen via emails, Gitter, Skype call and GitHub issues to discuss the state of Swagger Codegen 3.0.0. -But there was no consensus on the next steps and on the direction for Swagger Codegen 3.0.0. +1. The founding members felt that Swagger Codegen 3.0.0 was diverging too much from the philosophy of Swagger Codegen 2.x. +1. The founding members were concerned that the maintenance overhead of two separate branches (2.x, 3.x) would result in issues similar to those felt in the Python community. +1. The founding members wanted a more rapid [release cycle](https://github.com/OpenAPITools/openapi-generator/releases/) (weekly patch release, monthly minor release) so users do not need to wait for several months to get a stable release. +1. Having a community-driven version allows for innovation, reliability, and a [roadmap](https://github.com/OpenAPITools/openapi-generator/blob/master/docs/roadmap.md) owned by the community. -#### Are there any changes to the project license? +## Are there any changes to the project license? No, OpenAPI Generator is still using the [Apache license (version 2)](https://www.apache.org/licenses/LICENSE-2.0). -#### I am currently using Swagger Codegen 2.x. How can I upgrade the generator to OpenAPI Generator? +## I am currently using Swagger Codegen 2.x. How can I upgrade the generator to OpenAPI Generator? -OpenAPI Generator is based on Swagger Codegen `2.4.0-SNAPSHOT` version so the migration should be relatively straightforward. Refer to the [migration guide](migration-from-swagger-codegen.md) for more information. +OpenAPI Generator is based on Swagger Codegen `2.4.0-SNAPSHOT` version so the migration should be relatively straightforward. Refer to the [migration guide](./migration-from-swagger-codegen.md) for more information. -#### Who maintains this Q&A page? +## Who maintains this Q&A page? -This Q&A page is maintained by the [core team members](../README.md#openapi-generator-core-team). It is not maintained by a single person nor do these Q&As represent the views of any individual or person. +This Q&A page is maintained by the [core team members](./core-team.md). It is not maintained by any single person, nor do these Q&As represent the views of any individual or person. diff --git a/docs/roadmap.md b/docs/roadmap.md new file mode 100644 index 000000000000..c56e7dbe6414 --- /dev/null +++ b/docs/roadmap.md @@ -0,0 +1,85 @@ +--- +id: roadmap +title: Roadmap +--- + +This document lists short-term, medium-term, and long-term goals for the project. + +--- + +**NOTE** + +These are goals, not necessarily commitments. The sections are not intended to represent exclusive focus during these terms. For example, when you start at a college or university you may have a long-term goal to graduate and a short-term goal to find a job for supplemental income. We will similarly work toward many of our medium-term and long-term goals in the near future as we move toward meeting our short-term goals. + +--- + +## Short-term + +> Usability, stability, and marketing. + +Short term are focused on improving contributor and user productivity (part of this is getting the word out). + +* CLI improvements + * Search functionality (e.g. what generators support retrofit, what generators are available for kotlin) +* Build automation improvements +* Discuss consolidating current third-party build systems +* Investigate custom docker containerization for prepared build environments +* Automated release stability +* General +* OAS3.0 features support: anyOf, oneOf, callbacks, etc +* Consider opt-in telemetry about generators being used, limited to a counter of invocations by generator name). This would allow us to make prioritization decisions based on statistics. +* Code clean up + * centralize build scripts + * organize samples/bin scripts according to new generator names + * consolidate typescript generators + * jaxrs => use Swagger core v3 (see https://github.com/OpenAPITools/openapi-generator/issues/27[#27]) +* Documentation +* Static pages, preferably on gh-pages, devoted to each generator +* Explain generator options +* Centralized docs on generated code usage/examples/configuration + +## Medium-term + +> Feature set, well-defined API (code and templates), and extensibility improvements. + +### API +* Typed representation of the model bound to our templates. As it is, everything is treated an an Object, and this can lead to changes in the interface which might be unexpected from the template perspective. +* Feature set (potential generators to add; not an exhaustive list) + * Azure functions (node.js, server) + * Finagle HTTP Client (Scala, client) + * Finagle Http Server (Scala, server) + * Finatra (Scala, server) + * Kotlin Spring MVC/Springboot (server) + * C++ Server, any framework (server) + +### General +* Migrate from Maven to Gradle +* Java 9+ support +* Feature set (other options to investigate) +* SPI plugins + * Templating engine + * Language extensions + * Custom extensions (e.g. allowing users to load support for https://github.com/Azure/azure-rest-api-specs[azure-rest-api-specs]) +* Customizable templating engines (handlebars support) +* Unit-testing templates (to previously mentioned explicit type as an interface to the template) +* Reduce coupling +* Make types extending `CodegenConfig` become the generation entrypoint +* Allow current `CodegenConfig` types to define templating engine +* Allow current `CodegenConfig` types to modify workflow (currently encapsulated in `DefaultGenerator` and tightly coupled to the template engine +* Clearer reuse of "language" features, outside of "generator" types. That is, rather than enforcing polymorphic sharing of "language" which currently allows the super type to redefine framework-specific mapping functionality, generators could compose one or more language support types. +* Define template deprecation/removal process + +## Long-term + +> Expanding tooling offered, integrations, potentially SaaS offering to partially fund efforts. + +* Generator UI wrappers + * Move jimschubert/intellij-swagger-codegen plugin under the org, and rename + * Look into an Eclipse UI wrapper around the generator + * Look at Visual Studio Code (and/or Atom, sublime text) integration +* Provide a native GUI for viewing/editing specs. Most tools are currently geared toward developers, but often times it may be non-technical business users who are interested in an API. +* A paid service (SaaS) for generation may be enticing for some users. Such a service would allow for statistics (mentioned earlier in telemetry) +* Additional tools +* node.js build system(s) integration (grunt/gulp/webpack/etc) +* ruby gem +* others (which may require previously mentioned SaaS API) 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 de79af407f4e..1359ab000777 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 @@ -19,6 +19,7 @@ import io.airlift.airline.Command; import io.airlift.airline.Option; +import org.apache.commons.lang3.StringUtils; import org.openapitools.codegen.CliOption; import org.openapitools.codegen.CodegenConfig; import org.openapitools.codegen.CodegenConfigLoader; @@ -28,9 +29,10 @@ import java.io.*; import java.nio.charset.StandardCharsets; +import java.util.Map; +import static org.apache.commons.lang3.StringEscapeUtils.escapeHtml4; import static org.apache.commons.lang3.StringUtils.isEmpty; -import static org.apache.commons.lang3.StringUtils.isNotEmpty; @Command(name = "config-help", description = "Config help for chosen lang") public class ConfigHelp implements Runnable { @@ -49,12 +51,20 @@ public class ConfigHelp implements Runnable { description = "Optionally write help to this location, otherwise default is standard output") private String outputFile; + @Option(name = {"-f", "--format"}, title = "output format", + description = "Write output files in the desired format. Options are 'text' and 'markdown'. Default is 'text'.") + private String format; + + @Option(name = {"--markdown-header"}, title = "markdown header", + description = "When format=markdown, include this option to write out markdown headers (e.g. for docusaurus).") + private Boolean markdownHeader; + private String newline = System.lineSeparator(); @Override public void run() { if (isEmpty(generatorName)) { - System.err.println("[error] A generator name (--generator-name / -g) is required."); + LOGGER.error("[error] A generator name (--generator-name / -g) is required."); System.exit(1); } @@ -62,12 +72,18 @@ public void run() { StringBuilder sb = new StringBuilder(); CodegenConfig config = CodegenConfigLoader.forName(generatorName); - generatePlainTextHelp(sb, config); + if (StringUtils.isEmpty(format) || "text".equalsIgnoreCase(format)) { + generatePlainTextHelp(sb, config); + } else if ("markdown".equalsIgnoreCase(format)) { + generateMarkdownHelp(sb, config); + } else { + LOGGER.warn("[warning] Unrecognized format option: %s.%n", format); + } if (!isEmpty(outputFile)) { File out = new File(outputFile); //noinspection ResultOfMethodCallIgnored - out.mkdirs(); + out.getParentFile().mkdirs(); Writer writer = new BufferedWriter(new OutputStreamWriter(new FileOutputStream(out), StandardCharsets.UTF_8)); @@ -77,14 +93,68 @@ public void run() { System.out.print(sb.toString()); } } catch (GeneratorNotFoundException e) { - System.err.println(e.getMessage()); - System.err.println("[error] Check the spelling of the generator's name and try again."); + LOGGER.error(e.getMessage()); + LOGGER.error("[error] Check the spelling of the generator's name and try again."); System.exit(1); } catch (IOException e) { e.printStackTrace(); } } + private void generateMarkdownHelp(StringBuilder sb, CodegenConfig config) { + sb.append(newline); + + if (Boolean.TRUE.equals(markdownHeader)) { + sb.append("---").append(newline); + sb.append("id: generator-opts-").append(config.getTag().toValue()).append("-").append(config.getName()).append(newline); + sb.append("title: Config Options for ").append(generatorName).append(newline); + sb.append("sidebar_label: ").append(generatorName).append(newline); + sb.append("---").append(newline); + } else { + sb.append("## CONFIG OPTIONS"); + + if (Boolean.TRUE.equals(namedHeader)) { + sb.append(" for ").append(generatorName).append("").append(newline); + } + } + + sb.append(newline); + + sb.append("| Option | Description | Values | Default |").append(newline); + sb.append("| ------ | ----------- | ------ | ------- |").append(newline); + + for (CliOption langCliOption : config.cliOptions()) { + // start + sb.append("|"); + + // option + sb.append(escapeHtml4(langCliOption.getOpt())).append("|"); + // description + sb.append(escapeHtml4(langCliOption.getDescription())).append("|"); + + // values + Map enums = langCliOption.getEnum(); + if (enums != null) { + sb.append("
"); + + for (Map.Entry entry : enums.entrySet()) { + sb.append("
**").append(escapeHtml4(entry.getKey())).append("**
"); + sb.append("
").append(escapeHtml4(entry.getValue())).append("
"); + } + + sb.append("
"); + } else { + sb.append(" "); + } + sb.append("|"); + + // default + sb.append(escapeHtml4(langCliOption.getDefault())).append("|"); + + sb.append(newline); + } + } + private void generatePlainTextHelp(StringBuilder sb, CodegenConfig config) { sb.append(newline); sb.append("CONFIG OPTIONS"); diff --git a/modules/openapi-generator-cli/src/main/java/org/openapitools/codegen/cmd/ListGenerators.java b/modules/openapi-generator-cli/src/main/java/org/openapitools/codegen/cmd/ListGenerators.java index 83a3ada42c9d..eabc86f2de23 100644 --- a/modules/openapi-generator-cli/src/main/java/org/openapitools/codegen/cmd/ListGenerators.java +++ b/modules/openapi-generator-cli/src/main/java/org/openapitools/codegen/cmd/ListGenerators.java @@ -22,6 +22,9 @@ public class ListGenerators implements Runnable { @Option(name = {"-s", "--short" }, description = "shortened output (suitable for scripting)") private Boolean shortened = false; + @Option(name = {"-d", "--docsite" }, description = "format for docusaurus site output") + private Boolean docusaurus = false; + @Override public void run() { List generators = CodegenConfigLoader.getAll(); @@ -37,7 +40,7 @@ public void run() { sb.append(generator.getName()); } } else { - List types = Arrays.asList(CodegenType.values()); + CodegenType[] types = CodegenType.values(); sb.append("The following generators are available:"); @@ -60,11 +63,27 @@ private void appendForType(StringBuilder sb, CodegenType type, String typeName, .collect(Collectors.toList()); if(list.size() > 0) { - sb.append(typeName).append(" generators:"); + if (docusaurus) { + sb.append("## ").append(typeName).append(" generators"); + } else { + sb.append(typeName).append(" generators:"); + } sb.append(System.lineSeparator()); - list.stream() - .forEach(generator -> sb.append(" - ").append(generator.getName()).append(System.lineSeparator())); + list.forEach(generator -> { + if (docusaurus) { + sb.append("* "); + String id = String.format("generators/%s", generator.getName()); + sb.append("[").append(generator.getName()).append("](").append(id).append(")"); + + // trailing space is important for markdown list formatting + sb.append(" "); + } else { + sb.append(" - "); + sb.append(generator.getName()); + } + sb.append(System.lineSeparator()); + }); sb.append(System.lineSeparator()); sb.append(System.lineSeparator()); diff --git a/modules/openapi-generator/src/main/java/org/openapitools/codegen/CodegenType.java b/modules/openapi-generator/src/main/java/org/openapitools/codegen/CodegenType.java index dda89fe50c0d..1c5e318edbd4 100644 --- a/modules/openapi-generator/src/main/java/org/openapitools/codegen/CodegenType.java +++ b/modules/openapi-generator/src/main/java/org/openapitools/codegen/CodegenType.java @@ -50,6 +50,7 @@ public String toValue() { names.put("server", SERVER); names.put("documentation", DOCUMENTATION); names.put("schema", SCHEMA); + names.put("config", CONFIG); names.put("other", OTHER); } } diff --git a/website/README.md b/website/README.md new file mode 100755 index 000000000000..f3da77ff3424 --- /dev/null +++ b/website/README.md @@ -0,0 +1,193 @@ +This website was created with [Docusaurus](https://docusaurus.io/). + +# What's In This Document + +* [Get Started in 5 Minutes](#get-started-in-5-minutes) +* [Directory Structure](#directory-structure) +* [Editing Content](#editing-content) +* [Adding Content](#adding-content) +* [Full Documentation](#full-documentation) + +# Get Started in 5 Minutes + +1. Make sure all the dependencies for the website are installed: + +```sh +# Install dependencies +$ yarn +``` +2. Run your dev server: + +```sh +# Start the site +$ yarn start +``` + +## Directory Structure + +Your project file structure should look something like this + +``` +my-docusaurus/ + docs/ + doc-1.md + doc-2.md + doc-3.md + website/ + blog/ + 2016-3-11-oldest-post.md + 2017-10-24-newest-post.md + core/ + node_modules/ + pages/ + static/ + css/ + img/ + package.json + sidebar.json + siteConfig.js +``` + +# Editing Content + +## Editing an existing docs page + +Edit docs by navigating to `docs/` and editing the corresponding document: + +`docs/doc-to-be-edited.md` + +```markdown +--- +id: page-needs-edit +title: This Doc Needs To Be Edited +--- + +Edit me... +``` + +For more information about docs, click [here](https://docusaurus.io/docs/en/navigation) + +## Editing an existing blog post + +Edit blog posts by navigating to `website/blog` and editing the corresponding post: + +`website/blog/post-to-be-edited.md` +```markdown +--- +id: post-needs-edit +title: This Blog Post Needs To Be Edited +--- + +Edit me... +``` + +For more information about blog posts, click [here](https://docusaurus.io/docs/en/adding-blog) + +# Adding Content + +## Adding a new docs page to an existing sidebar + +1. Create the doc as a new markdown file in `/docs`, example `docs/newly-created-doc.md`: + +```md +--- +id: newly-created-doc +title: This Doc Needs To Be Edited +--- + +My new content here.. +``` + +1. Refer to that doc's ID in an existing sidebar in `website/sidebar.json`: + +```javascript +// Add newly-created-doc to the Getting Started category of docs +{ + "docs": { + "Getting Started": [ + "quick-start", + "newly-created-doc" // new doc here + ], + ... + }, + ... +} +``` + +For more information about adding new docs, click [here](https://docusaurus.io/docs/en/navigation) + +## Adding a new blog post + +1. Make sure there is a header link to your blog in `website/siteConfig.js`: + +`website/siteConfig.js` +```javascript +headerLinks: [ + ... + { blog: true, label: 'Blog' }, + ... +] +``` + +2. Create the blog post with the format `YYYY-MM-DD-My-Blog-Post-Title.md` in `website/blog`: + +`website/blog/2018-05-21-New-Blog-Post.md` + +```markdown +--- +author: Frank Li +authorURL: https://twitter.com/foobarbaz +authorFBID: 503283835 +title: New Blog Post +--- + +Lorem Ipsum... +``` + +For more information about blog posts, click [here](https://docusaurus.io/docs/en/adding-blog) + +## Adding items to your site's top navigation bar + +1. Add links to docs, custom pages or external links by editing the headerLinks field of `website/siteConfig.js`: + +`website/siteConfig.js` +```javascript +{ + headerLinks: [ + ... + /* you can add docs */ + { doc: 'my-examples', label: 'Examples' }, + /* you can add custom pages */ + { page: 'help', label: 'Help' }, + /* you can add external links */ + { href: 'https://github.com/facebook/Docusaurus', label: 'GitHub' }, + ... + ], + ... +} +``` + +For more information about the navigation bar, click [here](https://docusaurus.io/docs/en/navigation) + +## Adding custom pages + +1. Docusaurus uses React components to build pages. The components are saved as .js files in `website/pages/en`: +1. If you want your page to show up in your navigation header, you will need to update `website/siteConfig.js` to add to the `headerLinks` element: + +`website/siteConfig.js` +```javascript +{ + headerLinks: [ + ... + { page: 'my-new-custom-page', label: 'My New Custom Page' }, + ... + ], + ... +} +``` + +For more information about custom pages, click [here](https://docusaurus.io/docs/en/custom-pages). + +# Full Documentation + +Full documentation can be found on the [website](https://docusaurus.io/). diff --git a/website/blog/2018-12-24-new-website.md b/website/blog/2018-12-24-new-website.md new file mode 100644 index 000000000000..dee973e29d2a --- /dev/null +++ b/website/blog/2018-12-24-new-website.md @@ -0,0 +1,13 @@ +--- +title: New Website +author: Jim Schubert +authorURL: http://twitter.com/jimschubert +--- + +Every great open source project has great documentation. + +That's why we're proud to announce that we've adopted a new website and design for our official documentation. + + + +We will still continue to maintain the documentation on our GitHub repository. In fact, our website will be generated with [Docusaurus](https://docusaurus.io/en), so our docs on GitHub will still be incorporated into this site! diff --git a/website/core/EditThisPage.js b/website/core/EditThisPage.js new file mode 100644 index 000000000000..8b6b64227e91 --- /dev/null +++ b/website/core/EditThisPage.js @@ -0,0 +1,40 @@ +const React = require("react"); +const path = require("path"); + +const CompLibrary = require(path.join(__dirname, "../node_modules/docusaurus/lib/core/CompLibrary.js")); +const Container = CompLibrary.Container; +const MarkdownBlock = CompLibrary.MarkdownBlock; + +class EditThisPage extends React.Component { + renderHeader(title) { + if (!title) { + return null; + } + return ( +

+ {title} +

+ ) + } + + render() { + return ( + +
+ {this.renderHeader(this.props.title)} +

+ + Edit this page + +

+
+ + ); + } +} + +module.exports = EditThisPage; diff --git a/website/core/Footer.js b/website/core/Footer.js new file mode 100755 index 000000000000..db979fb8e88f --- /dev/null +++ b/website/core/Footer.js @@ -0,0 +1,101 @@ +/** + * Copyright (c) 2017-present, Facebook, Inc. + * + * This source code is licensed under the MIT license found in the + * LICENSE file in the root directory of this source tree. + */ + +const React = require('react'); + +class Footer extends React.Component { + docUrl(doc, language) { + const baseUrl = this.props.config.baseUrl; + const docsUrl = this.props.config.docsUrl; + const docsPart = `${docsUrl ? `${docsUrl}/` : ''}`; + const langPart = `${language ? `${language}/` : ''}`; + return `${baseUrl}${docsPart}${langPart}${doc}`; + } + + pageUrl(doc, language) { + const baseUrl = this.props.config.baseUrl; + return baseUrl + (language ? `${language}/` : '') + doc; + } + + render() { + return ( + + ); + } +} + +module.exports = Footer; diff --git a/website/dynamic/team.yml b/website/dynamic/team.yml new file mode 100644 index 000000000000..9fd8fbba0e54 --- /dev/null +++ b/website/dynamic/team.yml @@ -0,0 +1,23 @@ +core: + - name: William Cheng + github: wing328 + joined: 2015/07 + - name: Jim Schubert + github: jimschubert + twitter: jimschubert + joined: 2016/05 + - name: Christopher Bornet + github: cbornet + joined: 2016/05 + - name: jaz-ah + github: jaz-ah + joined: 2016/05 + - name: Akihito Nakano + github: ackintosh + joined: 2018/02 + - name: Jean-François Côté + github: JFCote + joined: 2018/03 + - name: Jérémie Bresson + github: jmini + joined: 2018/04 diff --git a/website/i18n/en.json b/website/i18n/en.json new file mode 100644 index 000000000000..bd03c5e2581f --- /dev/null +++ b/website/i18n/en.json @@ -0,0 +1,377 @@ +{ + "_comment": "This file is auto-generated by write-translations.js", + "localized-strings": { + "next": "Next", + "previous": "Previous", + "tagline": "Generate clients, servers, and documentation from OpenAPI 2.0/3.x documents", + "docs": { + "release-3-0-0": { + "title": "Release Notes: 3.0.0", + "sidebar_label": "Release Notes: 3.0.0" + }, + "code-of-conduct": { + "title": "Contributor Covenant Code of Conduct" + }, + "contributing": { + "title": "Guidelines For Contributing" + }, + "core-team": { + "title": "Core Team Members" + }, + "customization": { + "title": "Customization" + }, + "faq": { + "title": "FAQ" + }, + "generators": { + "title": "Generators List" + }, + "generators/ada-server": { + "title": "generators/ada-server" + }, + "generators/ada": { + "title": "generators/ada" + }, + "generators/android": { + "title": "generators/android" + }, + "generators/apache2": { + "title": "generators/apache2" + }, + "generators/apex": { + "title": "generators/apex" + }, + "generators/aspnetcore": { + "title": "generators/aspnetcore" + }, + "generators/bash": { + "title": "generators/bash" + }, + "generators/c": { + "title": "generators/c" + }, + "generators/clojure": { + "title": "generators/clojure" + }, + "generators/cpp-pistache-server": { + "title": "generators/cpp-pistache-server" + }, + "generators/cpp-qt5-client": { + "title": "generators/cpp-qt5-client" + }, + "generators/cpp-qt5-qhttpengine-server": { + "title": "generators/cpp-qt5-qhttpengine-server" + }, + "generators/cpp-restbed-server": { + "title": "generators/cpp-restbed-server" + }, + "generators/cpp-restsdk": { + "title": "generators/cpp-restsdk" + }, + "generators/cpp-tizen": { + "title": "generators/cpp-tizen" + }, + "generators/csharp-dotnet2": { + "title": "generators/csharp-dotnet2" + }, + "generators/csharp-nancyfx": { + "title": "generators/csharp-nancyfx" + }, + "generators/csharp-refactor": { + "title": "generators/csharp-refactor" + }, + "generators/csharp": { + "title": "generators/csharp" + }, + "generators/cwiki": { + "title": "generators/cwiki" + }, + "generators/dart-jaguar": { + "title": "generators/dart-jaguar" + }, + "generators/dart": { + "title": "generators/dart" + }, + "generators/dynamic-html": { + "title": "generators/dynamic-html" + }, + "generators/eiffel": { + "title": "generators/eiffel" + }, + "generators/elixir": { + "title": "generators/elixir" + }, + "generators/elm": { + "title": "generators/elm" + }, + "generators/erlang-client": { + "title": "generators/erlang-client" + }, + "generators/erlang-proper": { + "title": "generators/erlang-proper" + }, + "generators/erlang-server": { + "title": "generators/erlang-server" + }, + "generators/flash": { + "title": "generators/flash" + }, + "generators/go-gin-server": { + "title": "generators/go-gin-server" + }, + "generators/go-server": { + "title": "generators/go-server" + }, + "generators/go": { + "title": "generators/go" + }, + "generators/graphql-schema": { + "title": "generators/graphql-schema" + }, + "generators/graphql-server": { + "title": "generators/graphql-server" + }, + "generators/groovy": { + "title": "generators/groovy" + }, + "generators/haskell-http-client": { + "title": "generators/haskell-http-client" + }, + "generators/haskell": { + "title": "generators/haskell" + }, + "generators/html": { + "title": "generators/html" + }, + "generators/html2": { + "title": "generators/html2" + }, + "generators/java-inflector": { + "title": "generators/java-inflector" + }, + "generators/java-msf4j": { + "title": "generators/java-msf4j" + }, + "generators/java-pkmst": { + "title": "generators/java-pkmst" + }, + "generators/java-play-framework": { + "title": "generators/java-play-framework" + }, + "generators/java-undertow-server": { + "title": "generators/java-undertow-server" + }, + "generators/java-vertx": { + "title": "generators/java-vertx" + }, + "generators/java": { + "title": "generators/java" + }, + "generators/javascript-closure-angular": { + "title": "generators/javascript-closure-angular" + }, + "generators/javascript-flowtyped": { + "title": "generators/javascript-flowtyped" + }, + "generators/javascript": { + "title": "generators/javascript" + }, + "generators/jaxrs-cxf-cdi": { + "title": "generators/jaxrs-cxf-cdi" + }, + "generators/jaxrs-cxf-client": { + "title": "generators/jaxrs-cxf-client" + }, + "generators/jaxrs-cxf": { + "title": "generators/jaxrs-cxf" + }, + "generators/jaxrs-jersey": { + "title": "generators/jaxrs-jersey" + }, + "generators/jaxrs-resteasy-eap": { + "title": "generators/jaxrs-resteasy-eap" + }, + "generators/jaxrs-resteasy": { + "title": "generators/jaxrs-resteasy" + }, + "generators/jaxrs-spec": { + "title": "generators/jaxrs-spec" + }, + "generators/jmeter": { + "title": "generators/jmeter" + }, + "generators/kotlin-server": { + "title": "generators/kotlin-server" + }, + "generators/kotlin-spring": { + "title": "generators/kotlin-spring" + }, + "generators/kotlin": { + "title": "generators/kotlin" + }, + "generators/lua": { + "title": "generators/lua" + }, + "generators/mysql-schema": { + "title": "generators/mysql-schema" + }, + "generators/nodejs-server": { + "title": "generators/nodejs-server" + }, + "generators/objc": { + "title": "generators/objc" + }, + "generators/openapi-yaml": { + "title": "generators/openapi-yaml" + }, + "generators/openapi": { + "title": "generators/openapi" + }, + "generators/perl": { + "title": "generators/perl" + }, + "generators/php-laravel": { + "title": "generators/php-laravel" + }, + "generators/php-lumen": { + "title": "generators/php-lumen" + }, + "generators/php-silex": { + "title": "generators/php-silex" + }, + "generators/php-slim": { + "title": "generators/php-slim" + }, + "generators/php-symfony": { + "title": "generators/php-symfony" + }, + "generators/php-ze-ph": { + "title": "generators/php-ze-ph" + }, + "generators/php": { + "title": "generators/php" + }, + "generators/powershell": { + "title": "generators/powershell" + }, + "generators/python-flask": { + "title": "generators/python-flask" + }, + "generators/python": { + "title": "generators/python" + }, + "generators/r": { + "title": "generators/r" + }, + "generators/README": { + "title": "generators/README" + }, + "generators/ruby-on-rails": { + "title": "generators/ruby-on-rails" + }, + "generators/ruby-sinatra": { + "title": "generators/ruby-sinatra" + }, + "generators/ruby": { + "title": "generators/ruby" + }, + "generators/rust-server": { + "title": "generators/rust-server" + }, + "generators/rust": { + "title": "generators/rust" + }, + "generators/scala-akka": { + "title": "generators/scala-akka" + }, + "generators/scala-finch": { + "title": "generators/scala-finch" + }, + "generators/scala-gatling": { + "title": "generators/scala-gatling" + }, + "generators/scala-httpclient": { + "title": "generators/scala-httpclient" + }, + "generators/scala-lagom-server": { + "title": "generators/scala-lagom-server" + }, + "generators/scalatra": { + "title": "generators/scalatra" + }, + "generators/scalaz": { + "title": "generators/scalaz" + }, + "generators/spring": { + "title": "generators/spring" + }, + "generators/swift2-deprecated": { + "title": "generators/swift2-deprecated" + }, + "generators/swift3-deprecated": { + "title": "generators/swift3-deprecated" + }, + "generators/swift4": { + "title": "generators/swift4" + }, + "generators/typescript-angular": { + "title": "generators/typescript-angular" + }, + "generators/typescript-angularjs": { + "title": "generators/typescript-angularjs" + }, + "generators/typescript-aurelia": { + "title": "generators/typescript-aurelia" + }, + "generators/typescript-axios": { + "title": "generators/typescript-axios" + }, + "generators/typescript-fetch": { + "title": "generators/typescript-fetch" + }, + "generators/typescript-inversify": { + "title": "generators/typescript-inversify" + }, + "generators/typescript-jquery": { + "title": "generators/typescript-jquery" + }, + "generators/typescript-node": { + "title": "generators/typescript-node" + }, + "integrations": { + "title": "Workflow Integrations" + }, + "swagger-codegen-migration": { + "title": "Migrating from Swagger Codegen" + }, + "openapi-generator-online": { + "title": "Online OpenAPI Generator" + }, + "fork-qna": { + "title": "Swagger Codegen Fork: Q&A" + }, + "roadmap": { + "title": "Roadmap" + } + }, + "links": { + "Roadmap": "Roadmap", + "Generators": "Generators", + "Team": "Team", + "Blog": "Blog" + }, + "categories": { + "About": "About", + "Process Documentation": "Process Documentation", + "Releases": "Releases", + "API": "API", + "First Category": "First Category" + } + }, + "pages-strings": { + "Help Translate|recruit community translators for your project": "Help Translate", + "Edit this Doc|recruitment message asking to edit the doc source": "Edit", + "Translate this Doc|recruitment message asking to translate the docs": "Translate" + } +} diff --git a/website/package.json b/website/package.json new file mode 100644 index 000000000000..0a32df0c139d --- /dev/null +++ b/website/package.json @@ -0,0 +1,17 @@ +{ + "scripts": { + "examples": "docusaurus-examples", + "start": "docusaurus-start", + "build": "docusaurus-build", + "publish-gh-pages": "docusaurus-publish", + "write-translations": "docusaurus-write-translations", + "version": "docusaurus-version", + "rename-version": "docusaurus-rename-version" + }, + "devDependencies": { + "docusaurus": "^1.6.2" + }, + "dependencies": { + "js-yaml": "^3.12.0" + } +} diff --git a/website/pages/en/help.js b/website/pages/en/help.js new file mode 100755 index 000000000000..2b790e46037f --- /dev/null +++ b/website/pages/en/help.js @@ -0,0 +1,54 @@ +/** + * Copyright (c) 2017-present, Facebook, Inc. + * + * This source code is licensed under the MIT license found in the + * LICENSE file in the root directory of this source tree. + */ + +const React = require('react'); + +const CompLibrary = require('../../core/CompLibrary.js'); + +const Container = CompLibrary.Container; +const GridBlock = CompLibrary.GridBlock; + +function Help(props) { + const {config: siteConfig, language = ''} = props; + const {baseUrl, docsUrl} = siteConfig; + const docsPart = `${docsUrl ? `${docsUrl}/` : ''}`; + const langPart = `${language ? `${language}/` : ''}`; + const docUrl = doc => `${baseUrl}${docsPart}${langPart}${doc}`; + + const supportLinks = [ + { + content: `Learn more using the [documentation on this site.](${docUrl( + 'doc1.html', + )})`, + title: 'Browse Docs', + }, + { + content: 'Ask questions about the documentation and project', + title: 'Join the community', + }, + { + content: "Find out what's new with this project", + title: 'Stay up to date', + }, + ]; + + return ( +
+ +
+
+

Need help?

+
+

This project is maintained by a dedicated group of people.

+ +
+ +
+ ); +} + +module.exports = Help; diff --git a/website/pages/en/index.js b/website/pages/en/index.js new file mode 100755 index 000000000000..f648f7713dcd --- /dev/null +++ b/website/pages/en/index.js @@ -0,0 +1,308 @@ +/** + * Copyright (c) 2017-present, Facebook, Inc. + * + * This source code is licensed under the MIT license found in the + * LICENSE file in the root directory of this source tree. + */ + +const React = require('react'); + +const CompLibrary = require('../../core/CompLibrary.js'); + +const MarkdownBlock = CompLibrary.MarkdownBlock; /* Used to read markdown */ +const Container = CompLibrary.Container; +const GridBlock = CompLibrary.GridBlock; +const translate = require('../../server/translate.js').translate; + +function stripMargin (template, ...expressions) { + let result = template.reduce((accumulator, part, i) => { + return accumulator + expressions[i - 1] + part + }); + + return result.replace(/\r?(\n)\s*\|/g, '$1'); +} + +class HomeSplash extends React.Component { + render() { + const {siteConfig, language = ''} = this.props; + const {baseUrl, docsUrl} = siteConfig; + const docsPart = `${docsUrl ? `${docsUrl}/` : ''}`; + const langPart = `${language ? `${language}/` : ''}`; + const docUrl = doc => `${baseUrl}${docsPart}${langPart}${doc}`; + + const SplashContainer = props => ( +
+
+
{props.children}
+
+
+ ); + + const Logo = props => ( +
+ Project Logo +
+ ); + + const ProjectTitle = () => ( +

+ {siteConfig.title} + {siteConfig.tagline} +

+ ); + + const PromoSection = props => ( +
+
+
{props.children}
+
+
+ ); + + const Button = props => ( + + ); + + return ( + +
+ + + + + + + + +
+ + ); + } +} + +class Index extends React.Component { + docUrl(doc, language) { + const baseUrl = this.props.config.baseUrl; + const docsUrl = this.props.config.docsUrl; + const docsPart = `${docsUrl ? `${docsUrl}/` : ''}`; + const langPart = `${language ? `${language}/` : ''}`; + return `${baseUrl}${docsPart}${langPart}${doc}`; + } + + pageUrl(doc, language) { + const baseUrl = this.props.config.baseUrl; + return baseUrl + (language ? `${language}/` : '') + doc; + } + + render() { + const {config: siteConfig, language = ''} = this.props; + const {baseUrl} = siteConfig; + + const Block = props => ( + + + + ); + + const FeatureCallout = () => ( +
+

Feature Callout

+ Feature Matrix *Coming Soon*! +
+ ); + + const tryHomebrewContents = stripMargin` + | **Install** via [homebrew](https://brew.sh/): + | + | \`\`\`bash + | brew install openapi-generator + | \`\`\` + | + | Then, **generate** a ruby client from a valid [petstore.yaml](https://raw.githubusercontent.com/openapitools/openapi-generator/master/modules/openapi-generator/src/test/resources/2_0/petstore.yaml) doc: + | + | \`\`\`bash + | openapi-generator generate -i petstore.yaml -g ruby -o /tmp/test/ + | \`\`\` + `; + const TryOutHomebrew = () => ( + + {[ + { + content: `${tryHomebrewContents}`, + image: `${baseUrl}img/tools/homebrew-256x256.png`, + imageAlign: 'left', + title: 'Try via Homebrew', + }, + ]} + + ); + + const tryDockerContents = stripMargin` + | The OpenAPI Generator image acts as a standalone executable. It can be used as an alternative to installing via homebrew, or for developers who are unable to install Java or upgrade the installed version. + | + | To generate code from a valid [petstore.yaml](https://raw.githubusercontent.com/openapitools/openapi-generator/master/modules/openapi-generator/src/test/resources/2_0/petstore.yaml) doc with this image, you'll need to mount a local location as a volume. + | \`\`\`bash + | docker run --rm \\ + | -v \${PWD}:/local openapitools/openapi-generator-cli generate \\ + | -i petstore.yaml \\ + | -g go \\ + | -o /local/out/go + | + `; + const TryOutDocker = () => ( + + {[ + { + content: `${tryDockerContents}`, + image: `${baseUrl}img/tools/docker.png`, + imageAlign: 'left', + title: 'Try via Docker', + }, + ]} + + ); + + // const Description = () => ( + // + // {[ + // { + // content: + // 'This is another description of how this project is useful', + // image: `${baseUrl}img/docusaurus.svg`, + // imageAlign: 'right', + // title: 'Description', + // }, + // ]} + // + // ); + + const LearnHow = () => ( + + {[ + { + content: 'OpenAPI Generator supports many different integrations and use cases, including (but not limited to):\n\n' + + '* Maven Plugin\n' + + '* Gradle Plugin\n' + + '* CLI via Homebrew\n' + + '* CLI via Docker\n' + + '* Generator SaaS\n\n' + + 'For details, see [Workflow Integrations](' + this.docUrl('integrations.html', this.props.language) + ')\n\n' + + 'Generation also allows for easy customization via options, custom templates, or even custom generators on your classpath. ' + + 'See [Customization](' + this.docUrl('customization.html', this.props.language) + ') for details.\n\n' + + 'As a very community-oriented project, the core team is also active on the project\'s [Gitter channel](https://gitter.im/OpenAPITools/openapi-generator).', + image: `${baseUrl}img/color-logo.svg`, + imageAlign: 'right', + title: 'Learn How', + }, + ]} + + ); + + const Features = () => ( +
+ + {[ + { + title: 'Clients', + content: 'With *50+* client generators, you can easily generate code to interact with any server which exposes an OpenAPI document.\n\n' + + 'Maintainers of APIs may also automatically generate and distribute clients as part of official SDKs.\n\n' + + 'Each client supports different options and features, but all templates can be replaced with your own Mustache-based templates.\n\n' + + 'See [Customization](' + this.docUrl('customization.html', this.props.language) + ') for details.', + image: `${baseUrl}img/icons/plug.svg`, + imageAlign: 'top', + classNames: 'feature-client' + }, + { + content: 'Getting started with server development can be tough, especially if you\'re evaluating technologies. We can reduce the burden when you bring your own OpenAPI document.\n\n' + + 'Generate server stubs for 40+ different languages and technologies, including Java, Kotlin, Go, and PHP.\n\n' + + 'Some generators support *Inversion of Control*, allowing you to iterate on design via your OpenAPI document without worrying about blowing away your entire domain layer when you regenerate code.', + image: `${baseUrl}img/icons/exchange.svg`, + imageAlign: 'top', + title: 'Servers', + }, + ]} + + + {[ + + { + content: 'Ever wanted to iteratively design a MySQL database, but writing table declarations was too tedious?\n\n' + + 'OpenAPI Generator offers some special generators such as Apache2 Configuration, MySQL and GraphQL schema generators.\n\n' + + 'You can easily extend these generators and their templates to create derivative generators!', + image: `${baseUrl}img/icons/pencil.svg`, + imageAlign: 'top', + title: 'Schemas/Configs', + }, + { + content: 'OpenAPI documents allow you to convert the metadata about your API into some other format.\n\n' + + 'We include documentation formats such as HTML and Cwiki, which allow you to distribute static documentation to your consumers.\n\n' + + 'We also support generating from OpenAPI 2.0 to newer JSON/YAML OpenAPI 3.x documents.', + image: `${baseUrl}img/icons/newspaper-o.svg`, + imageAlign: 'top', + title: 'Documentation', + }, + ]} + +
+ ); + + const Showcase = () => { + if ((siteConfig.users || []).length === 0) { + return null; + } + + const showcase = siteConfig.users + .filter(user => user.pinned) + .map(user => ( + + {user.caption} + + )); + + const pageUrl = page => baseUrl + (language ? `${language}/` : '') + page; + + return ( +
+

Who is Using This?

+

This project is used by all these people

+
{showcase}
+ +
+ ); + }; + + return ( +
+ +
+ + + + + + {/**/} + +
+
+ ); + } +} + +module.exports = Index; diff --git a/website/pages/en/team.js b/website/pages/en/team.js new file mode 100644 index 000000000000..26dfca9140c4 --- /dev/null +++ b/website/pages/en/team.js @@ -0,0 +1,93 @@ +const React = require("react"); +const path = require("path"); + +const CompLibrary = require("../../core/CompLibrary.js"); +const Container = CompLibrary.Container; + +const EditThisPage = require(path.resolve(process.cwd(), "core/EditThisPage.js")); + +const siteConfig = require(process.cwd() + "/siteConfig.js"); + +// This is based mostly off of Babel's website configuration for Members/orgs/etc. +const MediaLink = props => { + if (props.text) { + return ( + + ); + } else return null; +}; + +const Member = ({member}) => { + const { github, twitter, name, joined } = member; + const avatarUrl = `https://avatars.githubusercontent.com/${github}`; + const twitterUrl = `https://twitter.com/${twitter}`; + const githubUrl = `https://github.com/${github}`; + + return ( +
+
+ {{name}} +
+
+
{name}
+ + +
({joined})
+
+
+ ); +}; + +const MemberGroup = props => { + return ( +
+

{props.title}

+
+ {props.members.map(member => { + return ; + })} +
+
+ ); +}; + +class Team extends React.Component { + render() { + const team = siteConfig.team; + return ( +
+ + +
+ +
+ +
+ ); + } +} + +module.exports = Team; diff --git a/website/pages/en/users.js b/website/pages/en/users.js new file mode 100755 index 000000000000..039dc39ffa50 --- /dev/null +++ b/website/pages/en/users.js @@ -0,0 +1,48 @@ +/** + * Copyright (c) 2017-present, Facebook, Inc. + * + * This source code is licensed under the MIT license found in the + * LICENSE file in the root directory of this source tree. + */ + +const React = require('react'); + +const CompLibrary = require('../../core/CompLibrary.js'); + +const Container = CompLibrary.Container; + +class Users extends React.Component { + render() { + const {config: siteConfig} = this.props; + if ((siteConfig.users || []).length === 0) { + return null; + } + + const editUrl = `${siteConfig.repoUrl}/edit/master/website/siteConfig.js`; + const showcase = siteConfig.users.map(user => ( + + {user.caption} + + )); + + return ( +
+ +
+
+

Who is Using This?

+

This project is used by many folks

+
+
{showcase}
+

Are you using this project?

+ + Add your company + +
+ +
+ ); + } +} + +module.exports = Users; diff --git a/website/sidebars.json b/website/sidebars.json new file mode 100755 index 000000000000..5bb0b0ac81c4 --- /dev/null +++ b/website/sidebars.json @@ -0,0 +1,48 @@ +{ + "docs": { + "About": [ + "roadmap", + "faq", + "swagger-codegen-migration", + "fork-qna" + ], + + "Process Documentation": [ + { + "type": "subcategory", + "label": "Contributing", + "ids": [ + "contributing", + "code-of-conduct" + ] + }, + + { + "type": "subcategory", + "label": "Extending", + "ids": [ + "customization", + "integrations" + ] + }, + + { + "type": "subcategory", + "label": "Documentation", + "ids": [ + ] + } + ], + + "Releases": [ + "release-3-0-0" + ], + + "API": [ + "generators" + ] + }, + "docs-other": { + "First Category": ["doc4", "doc5"] + } +} diff --git a/website/siteConfig.js b/website/siteConfig.js new file mode 100755 index 000000000000..c8d39f1ce838 --- /dev/null +++ b/website/siteConfig.js @@ -0,0 +1,227 @@ +const fs = require('fs'); +const path = require('path'); +const parseYaml = require("js-yaml").safeLoad; + +const loadYaml = relativePath => parseYaml(fs.readFileSync(path.join(__dirname, relativePath), "utf8")); + +// See https://docusaurus.io/docs/site-config for all the possible +// site configuration options. + +const team = loadYaml("dynamic/team.yml"); + +const users = [ + // { + // caption: 'User1', + // // You will need to prepend the image path with your baseUrl + // // if it is not '/', like: '/test-site/img/docusaurus.svg'. + // image: '/img/docusaurus.svg', + // infoLink: 'https://www.facebook.com', + // pinned: true, + // }, + + { + caption: 'Angular.Schule', + image: '/img/companies/angular-schule.svg', + infoLink: 'https://angular.schule/', + pinned: true, + }, + { + caption: 'ASKUL', + image: '/img/companies/logo-askul-01.gif', + infoLink: 'https://www.askul.co.jp/', + pinned: true, + }, + { + caption: 'b<>com', + image: '/img/companies/b-com.png', + infoLink: 'https://b-com.com/en', + pinned: true, + }, + { + caption: 'Bithost GmbH', + image: '/img/companies/bithost.svg', + infoLink: 'https://www.bithost.ch/', + pinned: true, + }, + { + caption: 'Boxever', + image: '/img/companies/boxever.svg', + infoLink: 'https://www.boxever.com/', + pinned: true, + }, + { + caption: 'GMO Pepabo', + image: '/img/companies/pepabo.png', + infoLink: 'https://pepabo.com/en/', + pinned: true, + }, + { + caption: 'JustStar', + image: '/img/companies/juststar.png', + infoLink: 'https://www.juststarinfo.com/', + pinned: true, + }, + { + caption: 'Klarna', + image: '/img/companies/klarna.svg', + infoLink: 'https://www.klarna.com/us/', + pinned: true, + }, + { + caption: 'Metaswitch', + image: '/img/companies/metaswitch.svg', + infoLink: 'https://www.metaswitch.com/', + pinned: false, + }, + { + caption: 'Myworkout', + image: '/img/companies/myworkout.png', + infoLink: 'https://myworkout.com/', + pinned: false, + }, + { + caption: 'Raiffeisen Schweiz Genossenschaft', + image: '/img/companies/raiffeisen.png', + infoLink: 'https://www.raiffeisen.ch/', + pinned: false, + }, + { + caption: 'RepreZen API Studio', + image: '/img/companies/reprezen.png', + infoLink: 'https://www.reprezen.com/swagger-openapi-code-generation-api-first-microservices-enterprise-development', + pinned: false, + }, + { + caption: 'REST United', + image: '/img/companies/rest-united.png', + infoLink: 'https://restunited.com/', + pinned: false, + }, + { + caption: 'Stingray', + image: '/img/companies/stingray.png', + infoLink: 'http://www.stingray.com/', + pinned: false, + }, + { + caption: 'Suva', + image: '/img/companies/suva.svg', + infoLink: 'https://www.suva.ch/', + pinned: false, + }, + { + caption: 'Telstra', + image: '/img/companies/telstra.svg', + infoLink: 'https://dev.telstra.com/', + pinned: false, + }, + + { + caption: 'TUI InfoTec GmbH', + image: '/img/companies/infotec.png', + infoLink: 'http://www.tui-infotec.com/', + pinned: false, + }, + { + caption: 'unblu inc.', + image: '/img/companies/unblu.svg', + infoLink: 'https://www.unblu.com/', + pinned: false, + }, + { + caption: 'Zalando', + image: '/img/companies/zalando.jpg', + infoLink: 'https://www.zalando.com/', + pinned: false, + }, +]; + +const siteConfig = { + title: 'OpenAPI Generator', // Title for your website. + tagline: 'Generate clients, servers, and documentation from OpenAPI 2.0/3.x documents', + url: 'https://your-docusaurus-test-site.com', // Your website URL + baseUrl: '/', // Base URL for your project */ + // For github.io type URLs, you would set the url and baseUrl like: + // url: 'https://facebook.github.io', + // baseUrl: '/test-site/', + + // Used for publishing and more + projectName: 'openapi-generator', + organizationName: 'openapitools', + // For top-level user or org sites, the organization is still the same. + // e.g., for the https://JoelMarcey.github.io site, it would be set like... + // organizationName: 'JoelMarcey' + + // For no header links in the top nav bar -> headerLinks: [], + headerLinks: [ + {doc: 'roadmap', label: 'Roadmap'}, + {doc: 'generators', label: 'Generators'}, + // {doc: 'doc4', label: 'API'}, + { page: "team", label: "Team" }, + // {page: 'help', label: 'Help'}, + {blog: true, label: 'Blog'}, + ], + + // If you have users set above, you add it here: + users, + + /* path to images for header/footer */ + headerIcon: 'img/mono-logo.svg', + footerIcon: 'img/mono-logo.svg', + favicon: 'img/favicon.png', + + /* Colors for website */ + colors: { + primaryColor: '#76c513', + secondaryColor: '#464446', + }, + + /* Custom fonts for website */ + /* + fonts: { + myFont: [ + "Times New Roman", + "Serif" + ], + myOtherFont: [ + "-apple-system", + "system-ui" + ] + }, + */ + + // This copyright info is used in /core/Footer.js and blog RSS/Atom feeds. + copyright: `Copyright © ${new Date().getFullYear()} OpenAPI-Generator Contributors (https://openapi-generator.tech)`, + + highlight: { + // Highlight.js theme to use for syntax highlighting in code blocks. + theme: 'default', + }, + + // Add custom scripts here that would be placed in