WIP: documentation

OpenAPITools · jimschubert · Dec 1, 2018 · Dec 1, 2018 · Dec 1, 2018 · Dec 1, 2018
commit 1fa63151b0ec66f7d4824a8347408a7086abed14
diff --git a/docs/core-team.md b/docs/core-team.md
diff --git a/docs/generators/ada-server.md b/docs/generators/ada-server.md
@@ -16,4 +16,4 @@ CONFIG OPTIONS for ada-server
 	projectName
 	    GNAT project name (Default: defaultProject)
 
-Back to the [generators list](README.md)
+
diff --git a/docs/generators/ada.md b/docs/generators/ada.md
@@ -16,4 +16,4 @@ CONFIG OPTIONS for ada
 	projectName
 	    GNAT project name (Default: defaultProject)
 
-Back to the [generators list](README.md)
+
diff --git a/docs/generators/android.md b/docs/generators/android.md
@@ -54,4 +54,4 @@ CONFIG OPTIONS for android
 	        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)
+
diff --git a/docs/generators/apache2.md b/docs/generators/apache2.md
@@ -16,4 +16,4 @@ CONFIG OPTIONS for apache2
 	userInfoPath
 	    Path to the user and group files
 
-Back to the [generators list](README.md)
+
diff --git a/docs/generators/apex.md b/docs/generators/apex.md
@@ -25,4 +25,4 @@ CONFIG OPTIONS for apex
 	namedCredential
 	    The named credential name for the HTTP callouts
 
-Back to the [generators list](README.md)
+
diff --git a/docs/generators/aspnetcore.md b/docs/generators/aspnetcore.md
@@ -31,4 +31,4 @@ CONFIG OPTIONS for aspnetcore
 	useSwashbuckle
 	    Uses the Swashbuckle.AspNetCore NuGet package for documentation. (Default: true)
 
-Back to the [generators list](README.md)
+
diff --git a/docs/generators/bash.md b/docs/generators/bash.md
@@ -37,4 +37,4 @@ CONFIG OPTIONS for bash
 	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)
+
diff --git a/docs/generators/clojure.md b/docs/generators/clojure.md
@@ -34,4 +34,4 @@ CONFIG OPTIONS for clojure
 	baseNamespace
 	    the base/top namespace (Default: generated from projectName)
 
-Back to the [generators list](README.md)
+
diff --git a/docs/generators/cpp-pistache-server.md b/docs/generators/cpp-pistache-server.md
@@ -7,4 +7,4 @@ CONFIG OPTIONS for cpp-pistache-server
 	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)
+
diff --git a/docs/generators/cpp-qt5-qhttpengine-server.md b/docs/generators/cpp-qt5-qhttpengine-server.md
@@ -16,4 +16,4 @@ CONFIG OPTIONS for cpp-qt5-qhttpengine-server
 	cppNamespace
 	    C++ namespace (convention: name::space::for::api). (Default: OpenAPI)
 
-Back to the [generators list](README.md)
+
diff --git a/docs/generators/cpp-qt5.md b/docs/generators/cpp-qt5.md
@@ -19,4 +19,4 @@ CONFIG OPTIONS for cpp-qt5
 	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
@@ -16,4 +16,4 @@ CONFIG OPTIONS for cpp-restbed-server
 	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)
+
diff --git a/docs/generators/cpp-restsdk.md b/docs/generators/cpp-restsdk.md
@@ -19,4 +19,4 @@ CONFIG OPTIONS for cpp-restsdk
 	generateGMocksForApis
 	    Generate Google Mock classes for APIs.
 
-Back to the [generators list](README.md)
+
diff --git a/docs/generators/cpp-tizen.md b/docs/generators/cpp-tizen.md
@@ -13,4 +13,4 @@ CONFIG OPTIONS for cpp-tizen
 	prependFormOrBodyParameters
 	    Add form or body parameters to the beginning of the parameter list. (Default: false)
 
-Back to the [generators list](README.md)
+
diff --git a/docs/generators/csharp-dotnet2.md b/docs/generators/csharp-dotnet2.md
@@ -10,4 +10,4 @@ CONFIG OPTIONS for csharp-dotnet2
 	clientPackage
 	    C# client package name (convention: Camel.Case). (Default: Org.OpenAPITools.Client)
 
-Back to the [generators list](README.md)
+
diff --git a/docs/generators/csharp-nancyfx.md b/docs/generators/csharp-nancyfx.md
@@ -43,4 +43,4 @@ CONFIG OPTIONS for csharp-nancyfx
 	asyncServer
 	    Set to true to enable the generation of async routes/endpoints. (Default: false)
 
-Back to the [generators list](README.md)
+
diff --git a/docs/generators/csharp.md b/docs/generators/csharp.md
@@ -69,4 +69,4 @@ CONFIG OPTIONS for csharp
 	validatable
 	    Generates self-validatable models. (Default: true)
 
-Back to the [generators list](README.md)
+
diff --git a/docs/generators/cwiki.md b/docs/generators/cwiki.md
@@ -43,4 +43,4 @@ CONFIG OPTIONS for cwiki
 	artifactVersion
 	    artifact version in generated pom.xml
 
-Back to the [generators list](README.md)
+
diff --git a/docs/generators/dart-jaguar.md b/docs/generators/dart-jaguar.md
@@ -34,4 +34,4 @@ CONFIG OPTIONS for dart-jaguar
 	supportDart2
 	    support dart2 (Default: true)
 
-Back to the [generators list](README.md)
+
diff --git a/docs/generators/dart.md b/docs/generators/dart.md
@@ -34,4 +34,4 @@ CONFIG OPTIONS for dart
 	supportDart2
 	    support dart2 (Default: true)
 
-Back to the [generators list](README.md)
+
diff --git a/docs/generators/dynamic-html.md b/docs/generators/dynamic-html.md
@@ -25,4 +25,4 @@ CONFIG OPTIONS for dynamic-html
 	artifactVersion
 	    artifact version in generated pom.xml
 
-Back to the [generators list](README.md)
+
diff --git a/docs/generators/eiffel.md b/docs/generators/eiffel.md
@@ -10,4 +10,4 @@ CONFIG OPTIONS for eiffel
 	hideGenerationTimestamp
 	    Hides the generation timestamp when files are generated. (Default: true)
 
-Back to the [generators list](README.md)
+
diff --git a/docs/generators/elixir.md b/docs/generators/elixir.md
@@ -22,4 +22,4 @@ CONFIG OPTIONS for elixir
 	packageName
 	    Elixir package name (convention: lowercase).
 
-Back to the [generators list](README.md)
+
diff --git a/docs/generators/elm.md b/docs/generators/elm.md
@@ -9,4 +9,4 @@ CONFIG OPTIONS for elm
 	elmPrefixCustomTypeVariants
 	    Prefix custom type variants (Default: false)
 
-Back to the [generators list](README.md)
+
diff --git a/docs/generators/erlang-client.md b/docs/generators/erlang-client.md
@@ -7,4 +7,4 @@ CONFIG OPTIONS for erlang-client
 	packageName
 	    Erlang application version (Default: 1.0.0)
 
-Back to the [generators list](README.md)
+
diff --git a/docs/generators/erlang-server.md b/docs/generators/erlang-server.md
@@ -7,4 +7,4 @@ CONFIG OPTIONS for erlang-server
 	openAPISpecName
 	    Openapi Spec Name. (Default: openapi)
 
-Back to the [generators list](README.md)
+
diff --git a/docs/generators/flash.md b/docs/generators/flash.md
@@ -13,4 +13,4 @@ CONFIG OPTIONS for flash
 	sourceFolder
 	    source folder for generated code. e.g. flash
 
-Back to the [generators list](README.md)
+
diff --git a/docs/generators/go-gin-server.md b/docs/generators/go-gin-server.md
@@ -7,4 +7,4 @@ CONFIG OPTIONS for go-gin-server
 	hideGenerationTimestamp
 	    Hides the generation timestamp when files are generated. (Default: true)
 
-Back to the [generators list](README.md)
+
diff --git a/docs/generators/go-server.md b/docs/generators/go-server.md
@@ -7,4 +7,4 @@ CONFIG OPTIONS for go-server
 	hideGenerationTimestamp
 	    Hides the generation timestamp when files are generated. (Default: true)
 
-Back to the [generators list](README.md)
+
diff --git a/docs/generators/go.md b/docs/generators/go.md
@@ -19,4 +19,4 @@ CONFIG OPTIONS for go
 	prependFormOrBodyParameters
 	    Add form or body parameters to the beginning of the parameter list. (Default: false)
 
-Back to the [generators list](README.md)
+
diff --git a/docs/generators/groovy.md b/docs/generators/groovy.md
@@ -116,4 +116,4 @@ CONFIG OPTIONS for groovy
 	configPackage
 	    configuration package for generated code
 
-Back to the [generators list](README.md)
+
diff --git a/docs/generators/haskell-http-client.md b/docs/generators/haskell-http-client.md
@@ -70,4 +70,4 @@ CONFIG OPTIONS for haskell-http-client
 	hideGenerationTimestamp
 	    Hides the generation timestamp when files are generated. (Default: true)
 
-Back to the [generators list](README.md)
+
diff --git a/docs/generators/haskell.md b/docs/generators/haskell.md
@@ -19,4 +19,4 @@ CONFIG OPTIONS for haskell
 	apiPackage
 	    package for generated api classes
 
-Back to the [generators list](README.md)
+
diff --git a/docs/generators/html.md b/docs/generators/html.md
@@ -43,4 +43,4 @@ CONFIG OPTIONS for html
 	artifactVersion
 	    artifact version in generated pom.xml
 
-Back to the [generators list](README.md)
+
diff --git a/docs/generators/html2.md b/docs/generators/html2.md
@@ -55,4 +55,4 @@ CONFIG OPTIONS for html2
 	artifactVersion
 	    artifact version in generated pom.xml
 
-Back to the [generators list](README.md)
+
diff --git a/docs/generators/java-inflector.md b/docs/generators/java-inflector.md
@@ -113,4 +113,4 @@ CONFIG OPTIONS for java-inflector
 	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)
+
diff --git a/docs/generators/java-msf4j.md b/docs/generators/java-msf4j.md
@@ -130,4 +130,4 @@ CONFIG OPTIONS for java-msf4j
 	        jersey1 - Jersey core 1.x
 	        jersey2 - Jersey core 2.x
 
-Back to the [generators list](README.md)
+
diff --git a/docs/generators/java-pkmst.md b/docs/generators/java-pkmst.md
@@ -143,4 +143,4 @@ CONFIG OPTIONS for java-pkmst
 	pkmstInterceptor
 	    PKMST Interceptor
 
-Back to the [generators list](README.md)
+
diff --git a/docs/generators/java-play-framework.md b/docs/generators/java-play-framework.md
@@ -140,4 +140,4 @@ CONFIG OPTIONS for java-play-framework
 	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)
+
diff --git a/docs/generators/java-undertow-server.md b/docs/generators/java-undertow-server.md
@@ -113,4 +113,4 @@ CONFIG OPTIONS for java-undertow-server
 	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)
+
diff --git a/docs/generators/java-vertx.md b/docs/generators/java-vertx.md
@@ -119,4 +119,4 @@ CONFIG OPTIONS for java-vertx
 	vertxSwaggerRouterVersion
 	    Specify the version of the swagger router library
 
-Back to the [generators list](README.md)
+
diff --git a/docs/generators/java.md b/docs/generators/java.md
@@ -161,4 +161,4 @@ CONFIG OPTIONS for java
 	        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)
+
diff --git a/docs/generators/javascript-closure-angular.md b/docs/generators/javascript-closure-angular.md
@@ -19,4 +19,4 @@ CONFIG OPTIONS for javascript-closure-angular
 	useEs6
 	    use ES6 templates (Default: false)
 
-Back to the [generators list](README.md)
+
diff --git a/docs/generators/javascript-flowtyped.md b/docs/generators/javascript-flowtyped.md
@@ -31,4 +31,4 @@ CONFIG OPTIONS for javascript-flowtyped
 	snapshot
 	    When setting this property to true the version will be suffixed with -SNAPSHOT.yyyyMMddHHmm (Default: false)
 
-Back to the [generators list](README.md)
+
diff --git a/docs/generators/javascript.md b/docs/generators/javascript.md
@@ -64,4 +64,4 @@ CONFIG OPTIONS for javascript
 	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)
+
diff --git a/docs/generators/jaxrs-cxf-cdi.md b/docs/generators/jaxrs-cxf-cdi.md
@@ -144,4 +144,4 @@ CONFIG OPTIONS for jaxrs-cxf-cdi
 	useBeanValidation
 	    Use BeanValidation API annotations (Default: true)
 
-Back to the [generators list](README.md)
+
diff --git a/docs/generators/jaxrs-cxf-client.md b/docs/generators/jaxrs-cxf-client.md
@@ -125,4 +125,4 @@ CONFIG OPTIONS for jaxrs-cxf-client
 	useGenericResponse
 	    Use generic response (Default: false)
 
-Back to the [generators list](README.md)
+
diff --git a/docs/generators/jaxrs-cxf.md b/docs/generators/jaxrs-cxf.md
@@ -176,4 +176,4 @@ CONFIG OPTIONS for jaxrs-cxf
 	useGenericResponse
 	    Use generic response (Default: false)
 
-Back to the [generators list](README.md)
+
diff --git a/docs/generators/jaxrs-jersey.md b/docs/generators/jaxrs-jersey.md
@@ -136,4 +136,4 @@ CONFIG OPTIONS for jaxrs-jersey
 	useTags
 	    use tags for creating interface and controller classnames (Default: false)
 
-Back to the [generators list](README.md)
+
diff --git a/docs/generators/jaxrs-resteasy-eap.md b/docs/generators/jaxrs-resteasy-eap.md
@@ -134,4 +134,4 @@ CONFIG OPTIONS for jaxrs-resteasy-eap
 	useSwaggerFeature
 	    Use dynamic Swagger generator (Default: false)
 
-Back to the [generators list](README.md)
+
diff --git a/docs/generators/jaxrs-resteasy.md b/docs/generators/jaxrs-resteasy.md
@@ -128,4 +128,4 @@ CONFIG OPTIONS for jaxrs-resteasy
 	generateJbossDeploymentDescriptor
 	    Generate Jboss Deployment Descriptor (Default: false)
 
-Back to the [generators list](README.md)
+
diff --git a/docs/generators/jaxrs-spec.md b/docs/generators/jaxrs-spec.md
@@ -141,4 +141,4 @@ CONFIG OPTIONS for jaxrs-spec
 	useSwaggerAnnotations
 	    Whether to generate Swagger annotations. (Default: true)
 
-Back to the [generators list](README.md)
+
diff --git a/docs/generators/jmeter.md b/docs/generators/jmeter.md
@@ -13,4 +13,4 @@ CONFIG OPTIONS for jmeter
 	prependFormOrBodyParameters
 	    Add form or body parameters to the beginning of the parameter list. (Default: false)
 
-Back to the [generators list](README.md)
+
diff --git a/docs/generators/kotlin-server.md b/docs/generators/kotlin-server.md
@@ -41,4 +41,4 @@ CONFIG OPTIONS for kotlin-server
 	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)
+
diff --git a/docs/generators/kotlin-spring.md b/docs/generators/kotlin-spring.md
@@ -59,4 +59,4 @@ CONFIG OPTIONS for kotlin-spring
 	    library template (sub-template) to use (Default: spring-boot)
 	        spring-boot - Spring-boot Server application.
 
-Back to the [generators list](README.md)
+
diff --git a/docs/generators/kotlin.md b/docs/generators/kotlin.md
@@ -33,4 +33,4 @@ CONFIG OPTIONS for kotlin
 	        array - kotlin.Array
 	        list - kotlin.collections.List
 
-Back to the [generators list](README.md)
+
diff --git a/docs/generators/lua.md b/docs/generators/lua.md
@@ -10,4 +10,4 @@ CONFIG OPTIONS for lua
 	hideGenerationTimestamp
 	    Hides the generation timestamp when files are generated. (Default: true)
 
-Back to the [generators list](README.md)
+
diff --git a/docs/generators/mysql-schema.md b/docs/generators/mysql-schema.md
@@ -7,4 +7,4 @@ CONFIG OPTIONS for mysql-schema
 	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)
+
diff --git a/docs/generators/nodejs-server.md b/docs/generators/nodejs-server.md
@@ -22,4 +22,4 @@ CONFIG OPTIONS for nodejs-server
 	serverPort
 	    TCP port to listen on.
 
-Back to the [generators list](README.md)
+
diff --git a/docs/generators/objc.md b/docs/generators/objc.md
@@ -25,4 +25,4 @@ CONFIG OPTIONS for objc
 	hideGenerationTimestamp
 	    Hides the generation timestamp when files are generated. (Default: true)
 
-Back to the [generators list](README.md)
+
diff --git a/docs/generators/openapi-yaml.md b/docs/generators/openapi-yaml.md
@@ -16,4 +16,4 @@ CONFIG OPTIONS for openapi-yaml
 	outputFile
 	    output filename
 
-Back to the [generators list](README.md)
+
diff --git a/docs/generators/openapi.md b/docs/generators/openapi.md
@@ -13,4 +13,4 @@ CONFIG OPTIONS for openapi
 	prependFormOrBodyParameters
 	    Add form or body parameters to the beginning of the parameter list. (Default: false)
 
-Back to the [generators list](README.md)
+
diff --git a/docs/generators/perl.md b/docs/generators/perl.md
@@ -19,4 +19,4 @@ CONFIG OPTIONS for perl
 	prependFormOrBodyParameters
 	    Add form or body parameters to the beginning of the parameter list. (Default: false)
 
-Back to the [generators list](README.md)
+
diff --git a/docs/generators/php-laravel.md b/docs/generators/php-laravel.md
@@ -40,4 +40,4 @@ CONFIG OPTIONS for php-laravel
 	artifactVersion
 	    The version to use in the composer package version field. e.g. 1.2.3
 
-Back to the [generators list](README.md)
+
diff --git a/docs/generators/php-lumen.md b/docs/generators/php-lumen.md
@@ -40,4 +40,4 @@ CONFIG OPTIONS for php-lumen
 	artifactVersion
 	    The version to use in the composer package version field. e.g. 1.2.3
 
-Back to the [generators list](README.md)
+
diff --git a/docs/generators/php-silex.md b/docs/generators/php-silex.md
@@ -13,4 +13,4 @@ CONFIG OPTIONS for php-silex
 	prependFormOrBodyParameters
 	    Add form or body parameters to the beginning of the parameter list. (Default: false)
 
-Back to the [generators list](README.md)
+
Original file line number	Diff line number	Diff line change
Expand Up		@@ -16,4 +16,4 @@ CONFIG OPTIONS for ada-server
		projectName
		GNAT project name (Default: defaultProject)

		Back to the [generators list](README.md)
Original file line number	Diff line number	Diff line change
Expand Up		@@ -54,4 +54,4 @@ CONFIG OPTIONS for android
		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)
Original file line number	Diff line number	Diff line change
Expand Up		@@ -16,4 +16,4 @@ CONFIG OPTIONS for apache2
		userInfoPath
		Path to the user and group files

		Back to the [generators list](README.md)
Original file line number	Diff line number	Diff line change
Expand Up		@@ -25,4 +25,4 @@ CONFIG OPTIONS for apex
		namedCredential
		The named credential name for the HTTP callouts

		Back to the [generators list](README.md)
Original file line number	Diff line number	Diff line change
Expand Up		@@ -31,4 +31,4 @@ CONFIG OPTIONS for aspnetcore
		useSwashbuckle
		Uses the Swashbuckle.AspNetCore NuGet package for documentation. (Default: true)

		Back to the [generators list](README.md)
Original file line number	Diff line number	Diff line change
Expand Up		@@ -37,4 +37,4 @@ CONFIG OPTIONS for bash
		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)
Original file line number	Diff line number	Diff line change
Expand Up		@@ -34,4 +34,4 @@ CONFIG OPTIONS for clojure
		baseNamespace
		the base/top namespace (Default: generated from projectName)

		Back to the [generators list](README.md)
Original file line number	Diff line number	Diff line change
Expand Up		@@ -7,4 +7,4 @@ CONFIG OPTIONS for cpp-pistache-server
		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)
Original file line number	Diff line number	Diff line change
Expand Up		@@ -16,4 +16,4 @@ CONFIG OPTIONS for cpp-qt5-qhttpengine-server
		cppNamespace
		C++ namespace (convention: name::space::for::api). (Default: OpenAPI)

		Back to the [generators list](README.md)
Original file line number	Diff line number	Diff line change
Expand Up		@@ -19,4 +19,4 @@ CONFIG OPTIONS for cpp-qt5
		optionalProjectFile
		Generate client.pri. (Default: true)

		Back to the [generators list](README.md)